Repository navigation
docs: add a Canton DevKit case study (running Canton locally) - #316
Merged
Merged
Conversation
A worked, end-to-end example: boot a Splice LocalNet with Canton DevKit and issue, mint, and transfer a CIP-0112 (Token Standard V2) instrument from both the CLI and the Web UI, including the cross-participant accept flow. This is the grant deliverable for a published case study / blog post. Wired as a normal docs/ source page so it renders in the Starlight theme: a docs-map entry places it at case-studies/cip0112-token with a site description, a new "Case studies" sidebar group surfaces it, and the generated mirror is gitignored like the other synced pages.
The piece is a Canton DevKit case study — standing up a local Canton network — with the Token Standard flow as the worked example, not a CIP-0112 tutorial. Retitle to "Running a local Canton network with Canton DevKit", move it to case-studies/running-canton-locally, and relabel the sidebar entry so the framing matches the content.
srikanth-bitdynamics
changed the title
zheli
force-pushed
the
docs/case-study-cip0112
branch
from
August 18, 2026 16:04
ad4831c to
5d10e6e
Compare
Focus the article on current local-development workflows and trim outdated setup details so the guide is easier to follow.
zheli
added a commit
that referenced
this pull request
Aug 19, 2026
* docs: add CIP-0112 token case study to the site A worked, end-to-end example: boot a Splice LocalNet with Canton DevKit and issue, mint, and transfer a CIP-0112 (Token Standard V2) instrument from both the CLI and the Web UI, including the cross-participant accept flow. This is the grant deliverable for a published case study / blog post. Wired as a normal docs/ source page so it renders in the Starlight theme: a docs-map entry places it at case-studies/cip0112-token with a site description, a new "Case studies" sidebar group surfaces it, and the generated mirror is gitignored like the other synced pages. * docs: frame the case study around Canton DevKit, not just CIP-0112 The piece is a Canton DevKit case study — standing up a local Canton network — with the Token Standard flow as the worked example, not a CIP-0112 tutorial. Retitle to "Running a local Canton network with Canton DevKit", move it to case-studies/running-canton-locally, and relabel the sidebar entry so the framing matches the content. * docs: rewrite Canton DevKit case study for clarity Focus the article on current local-development workflows and trim outdated setup details so the guide is easier to follow. --------- Co-authored-by: Zhe Li <linuxcity.jn@gmail.com>
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
2 participants
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.
Adds a published case study to the docs site — the Canton Dev Fund milestone deliverable for a case study / blog post.
What it is
A Canton DevKit case study: standing up a full local Canton + Splice network with DevKit, then working an end-to-end Token Standard flow (CIP-0056 and CIP-0112) from both the CLI and the Web UI as the worked example — including the cross-participant
--no-wait→transfer acceptflow, the Amulet faucet, and burn. It's a DevKit adoption piece, not a token-only tutorial.How it's wired
Rendered as a normal
docs/*.mdsource page so it inherits the Starlight theme, fonts, and code styling — no bespoke layout:docs/case-study-canton-devkit.md— the content (single source of truth)website/docs-map.mjs— maps it tocase-studies/running-canton-locallywith a site descriptionwebsite/astro.config.mjs— a new Case studies sidebar group (label: "Running Canton locally")website/.gitignore— ignores the generated mirror, matching the other synced pagesAccuracy
Every command is verified against the shipped v0.17.2 CLI: stable V2 from Splice 0.6.11+ (no alpha profile), endpoint auto-resolution,
--no-wait/transfer accept --party, burn confirmation, and--format json.Verification
npm ci && npm run buildsucceeds (18 pages); previewed locally — the page renders in the docs theme with the sidebar entry and an auto-generated "On this page" TOC.Note: the byline says "Built under a Canton Dev Fund grant" as plain text; happy to link a public proposal URL if we have one.