Sitelet https://github.com/Moonsong-Labs/cf-docs/blob/main/CONTRIBUTING.md
Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (66 loc) · 5.57 KB

CONTRIBUTING.md

File metadata and controls

117 lines (66 loc) · 5.57 KB
Raw

Contributing to Canton Network Docs

Thanks for helping improve docs.canton.network.

This repo is the home for Canton Network documentation and content here should reflect the current, correct behavior of the latest Canton, Daml, and Splice releases.

Before you start

  • Search existing issues and PRs first to avoid duplicate work.

  • We prioritize PRs that fix inaccuracies, clarify confusing concepts, or add missing information. To minimize merge conflicts, PRs consisting solely of cosmetic reformatting may be closed.

  • Check the information in your PR against the current release before writing or editing a page, confirm the behavior, APIs, config, and defaults you're describing match the latest Canton and Splice releases. If you're documenting something version specific, say so explicitly rather than leaving it ambiguous.

  • Verify every technical claim: an AI-generated draft might hallucinate or invent details. Always check API signatures, CLI flags, config keys, version numbers, and code samples against the Actual Current Canton/Splice/Daml Release or source docs. Do not assume the model's output reflects the current release, and make sure to review everything before opening a PR.

Ways to contribute

Provide Feedback on a Docs Page

Every page on docs.canton.network has two feedback buttons in the footer:

  • Suggest edits
  • Raise issue
Suggest edits and Raise issue buttons in the page footer

Suggest edits

Use this to propose a direct change to the page, fix a typo, update a code sample, improve wording, etc.

How it works:

  • Click "Suggest edits" in the footer of any page.
  • GitHub opens the source file for that exact page.
  • Fork the repo, make your edits, and open a Pull Request.
  • Canton docs team reviews and merges accepted changes if all checks out.

Raise Issue

Use this to report a problem or request new content without editing the source yourself.

How it works:

  • Click "Raise Issue" in the footer of any page.
  • A GitHub Issue opens pre-filled with the path of the page you were on.
  • Describe in detail what's wrong or missing along with the source of information to verify, and submit.
  • The team reviews it and responds.

Alternatively, you can file an issue directly in the github repo here: https://github.com/canton-network/cf-docs/issues

Larger changes: PR from a local checkout

For new pages, restructuring, or anything touching multiple files, set up a local checkout, preview your changes with mintlify dev, and run mintlify broken-links before opening a PR.

Prerequisites

Either:

OR:

  • Node.js 24 (note that mintlify is not currently compatible with Node.js 26)
  • Python 3.14 if you are running any of the machinery for syncing snippets or updating generated docs

Running the dev server

direnv allow
cd docs-main && mintlify dev

The site will be available at http://localhost:3000.

Check for broken links

mintlify broken-links

Missing developer tooling

This repository is strictly for core network documentation, not a tooling directory. If you want to add a third-party wallet, SDK, indexer, explorer, or partner tool, please submit it to the Canton Developer Hub. All external tooling is maintained in that repository to ensure it is properly reviewed and tagged.

Open a PR there to add your tool. Maintaining external tooling in the Dev Hub ensures it can be properly reviewed, tagged, and featured on the new docs overview page.

Content and style guidelines

  • Match the tone and structure of the surrounding pages in docs-main/ don't introduce a new voice or format for a single page.

  • Prefer editing an existing page over creating a new one if the topic already has a home.

  • Keep code samples runnable and tested against current SDK/CLI versions.

  • If a page is generated or synced from an external source, refer to the 'Generate external snippets' section in cf-docs/README.md. Do not hand-edit the generated output. Instead, update the source or the snippet config in config/snippet-config/.

  • Links should be relative and verified with mintlify broken-links.

Licensing

By contributing, you agree your changes are licensed under this repo's license model, for more info see the README for details.

Review process

  • A member of the Canton docs team will review your PR for accuracy, value, and fit with existing content. We aim to do this within a week, but appreciate your patience if there are slight delays depending on the team's workload.

    If you have been collaborating with someone from the Canton team, please @mention them in your PR description so we can assign the right SME and make the review faster.

  • Expect feedback if a change is out of date with the current release, etc.

    Note: If any further queries or review questions in a PR get no response for more than a week, that PR will be closed immediately.

  • Once approved and checks pass, the docs team merges.

Questions about where something belongs, or whether a change is worth making? Open a Discussion before doing the work.