docs: add Documentation Checklist + surface chain-contribution flow#2049
Open
ryanRfox wants to merge 1 commit intox402-foundation:mainfrom
Open
docs: add Documentation Checklist + surface chain-contribution flow#2049ryanRfox wants to merge 1 commit intox402-foundation:mainfrom
ryanRfox wants to merge 1 commit intox402-foundation:mainfrom
Conversation
|
@ryanRfox is attempting to deploy a commit to the Coinbase Team on Vercel. A member of the Team first needs to authorize it. |
4 tasks
DEFAULT_ASSETS.md's 'Adding a New Chain' numbered flow stopped at 'Update all three SDKs' → 'Submit a PR' and did not mention the user-facing docs surfaces that also enumerate every chain with default-asset support. As a result, recent onboarding PRs have shipped with stale docs (e.g. the Radius PR x402-foundation#2038 updated the SDKs but not the docs table or Go README). The existing Cross-SDK Checklist at the bottom enumerates only the three code registries, mirroring the same gap. network-and-token-support.mdx has a parallel discoverability problem: the pointer to DEFAULT_ASSETS.md used a repo-relative path that resolves to a broken link on docs.x402.org, and the pointer sat inside the 'Default Assets for Dollar-String Pricing' intro rather than under 'Adding Support for New Networks' where a would-be contributor actually looks. The 'Adding' section itself described only runtime registration (server.register from consumer code) and did not mention the separate upstream-contribution path, and it also contained a 'Running Your Own Facilitator' subsection that is about facilitator infrastructure, not about adding networks — a topical mismatch. The page also ordered the 'Facilitators' section before 'Adding Support for New Networks', which inverts the natural read → use → extend → operate narrative. Changes: * DEFAULT_ASSETS.md: - Promote 'Update user-facing documentation' to a numbered step in 'Adding a New Chain' (new step 3, between 'Update all three SDKs' and 'Submit a PR'), with a cross-reference to the new checklist. - Append a new 'Documentation Checklist' section below the existing Cross-SDK Checklist, naming the two hot docs surfaces (network-and-token-support.mdx and go/mechanisms/evm/README.md) that must also be updated on a new chain onboarding. * docs/core-concepts/network-and-token-support.mdx: - Remove the oddly-placed 'See DEFAULT_ASSETS.md' link from the Dollar-String Pricing intro; replace with an in-page anchor pointing at the new contribution subsection. - Split 'Adding Support for New Networks' into two subsections: 'Runtime Registration' (the existing content, unchanged) and a new 'Contributing a New Default Asset' subsection that links to DEFAULT_ASSETS.md via an absolute github.com URL (so the link works on the published docs site) and explicitly names the cross-SDK + docs checklist. - Move 'Running Your Own Facilitator' out of 'Adding Support for New Networks' into the existing 'Facilitators' section, where it belongs topically. - Swap top-level section order: 'Adding Support for New Networks' now precedes 'Facilitators', matching the read → use → extend → operate narrative. No code changes. Documentation only.
ryanRfox
force-pushed
the
docs/extend-default-assets-cross-sdk-checklist
branch
from
c8ee259 to
28d8426
Compare
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.
Fixes #2048.
Changes
DEFAULT_ASSETS.md: append Documentation Checklist + promote docs update to its own named step in 'Adding a New Chain'docs/core-concepts/network-and-token-support.mdx:/DEFAULT_ASSETS.mdlink (absolutegithub.comURL)Verified locally via Mintlify dev server.
AI disclosure
This PR used an agentic coding workflow and was reviewed by Ryan R. Fox (an actual human) before posting.