Skip to content

docs: restructure and clarify the documentation set - #132

Merged
srikanth-bitdynamics merged 1 commit into
mainfrom
docs/clarity-pass
Aug 13, 2026
Merged

docs: restructure and clarify the documentation set#132
srikanth-bitdynamics merged 1 commit into
mainfrom
docs/clarity-pass

Conversation

@srikanth-bitdynamics

Copy link
Copy Markdown
Owner

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:

  • clearer hierarchy — a short lead per page, then sub-headings a reader can follow in order
  • diagrams where they explain a mechanism (the settlement boundary, the constant-product swap, the connect/trade handoff, the registry boundary, the read-vs-write API split)
  • short inlined Daml snippets copied from the source, next to the prose that describes them
  • cross-links from each concept to the test that proves it
  • plainer, more precise prose; deep or edge detail moved into per-page reference sections

Also:

  • Token Standard V2 (CIP-0112) wording updated to reflect that it is merged into Splice main and is the network default
  • plain-language comments added to the test files the docs link to (comments only; no test code changed)
  • Daml snippets are syntax-highlighted via a Shiki language alias in the docs-site config

Verified: 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.md is intentionally not included here (its test counts are being updated separately).

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
srikanth-bitdynamics merged commit 0bd6391 into main Aug 13, 2026
7 checks passed
@srikanth-bitdynamics
srikanth-bitdynamics deleted the docs/clarity-pass branch August 13, 2026 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant