Doc/improve docs#4
Merged
Merged
Conversation
Publish documentation at docs/ using the Diátaxis framework (tutorials, how-to, reference, explanation). Wave 1 covers the index, two end-to-end tutorials, and the full REST API reference. Adjust .gitignore to allow only the four public quadrants so existing planning docs in docs/ stay local.
Wave 2: five seller recipes (register, multi-chain, MPP, settlement status, on-ramp), four operator recipes (local stack, deploy, Temporal monitoring, circuit breakers), and the non-API reference docs for chains, fees, env vars, error codes, and CLI scripts.
Wave 3 closes the Diátaxis matrix. Seven explanation documents cover architecture, CCTP V2, the non-custodial model, dual protocol support, Temporal workflows, the security model, and merchantId as a primitive. Four contributor guides walk through dev setup, adding EVM chains, writing network adapters, and running the demo.
Shrink the README from 500+ to ~150 lines. Keep the value proposition, one primary diagram, and a 60-second seller quick start. Move detailed API tables, full chain matrix, fee schedule, infra, and scripts into docs/ (already committed) and link from the README. Replace the Key Documents section, which pointed at a planning file outside the public tree, with pointers to the four Diátaxis quadrants.
Move the four remaining ASCII flow diagrams to mermaid and restore the two x402 sequence diagrams that were dropped from the README. Places: - explanation/architecture.md: full request flow + x402 cross-chain + x402 same-chain sequence diagrams - explanation/temporal-workflows.md: state diagrams for sameChainSettle and crossChainSettle - reference/api/mpp.md: MPP charge mode sequence - tutorials/02-paywalled-api-with-x402.md: tutorial overview flow Capitalize Facilitator as the system name in the files being edited.
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.
No description provided.