docs: put the hosted tools in the sidebar - #7
Merged
Conversation
Six pages already link out to tools.tx402.io, but every one of those is an aside in the middle of a long page. That works for a reader who is already on that page and has the question the tool answers. It is invisible to someone scanning the sidebar to find out what exists — the links were live and still could not be found, which is the report that prompted this. The sidebar is autogenerated from the directory layout, so a different property cannot appear there by adding a file. This is the one place a standing entry has to be written by hand. Five links: the site itself, then the four tools a reader of these docs is most likely to want — inspect an endpoint, verify a challenge before signing, the policy playground, and debugging a failed payment. Labelled by what they do rather than by product name, matching how the in-page asides are written. Marked free, because the first question about a hosted service is whether it costs anything. They open in a new tab: this is a different origin, and losing your place in a guide to look at a tool is a bad trade.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Six pages already link out to
tools.tx402.io, but every one is an aside in the middle of a long page. That works for a reader already on that page with the question the tool answers. It is invisible to someone scanning the sidebar for what exists — the links were live and still could not be found, which is what prompted this.The sidebar is autogenerated from the directory layout, so a different property cannot appear there by adding a file. This is the one place a standing entry has to be written by hand.
Five entries under Hosted tools:
/(badged free)/inspect/verify/policy/replayLabelled by what they do rather than by product name, matching how the in-page asides read. Badged free because the first question about a hosted service is whether it costs anything. They open in a new tab — different origin, and losing your place in a guide to glance at a tool is a bad trade.
Verified with
pnpm docs:build: 24 pages, 47 md mirrors, and all five links present in the sidebar of every built page.