docs: restructure and clarify the documentation set - #132
Merged
Conversation
Rework the docs so a reader new to the codebase can build understanding top-down: clearer hierarchy, diagrams where they explain a mechanism, short inlined Daml snippets, and cross-links from concepts to the tests that prove them. Refresh Token Standard V2 wording to reflect that it is merged and the network default. Add plain-language comments to the tests the docs link to, and colour Daml snippets with a Shiki language alias.
srikanth-bitdynamics
force-pushed
the
docs/clarity-pass
branch
from
August 13, 2026 06:03
21714f8 to
23f8671
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
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.
Reworks the documentation so a reader new to the codebase can build understanding top-down, rather than assuming familiarity with the design.
Across concepts, guides, and reference:
Also:
mainand is the network defaultVerified: every doc-to-source and doc-to-test link and anchor resolves, the docs site builds, and the inlined snippets match the source.
getting-started.mdis intentionally not included here (its test counts are being updated separately).