docs: organize documentation (Diátaxis + C4 mermaid)#26
Merged
Conversation
Replace forked Uniswap README with engram-style landing and add docs/ scaffold following Diátaxis (overview, glossary, packages, flows, ADRs) plus C4 mermaid diagrams.
This was referenced May 4, 2026
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
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.
Summary
docs/scaffold following Diátaxis:overview,glossary, per-package reference, flows, diagrams, ADRs.protocol-core/sdkpackage split and the JSBI choice as ADRs.Structure
All docs respect Diátaxis line caps (reference ≤40, explanation ≤50, landing ≤80). Mermaid is raw
.mmd— GitHub renders it natively in markdown previews.Test plan