Public documentation source for Claire, rendered by Claire at docs.tryclaire.net. Start with the Introduction.
Edit pages under docs/ and open a pull request against main. Describe the user-visible
change and verify it against the current product. Do not include secrets, internal operator
notes, private source data, or promises of unshipped features.
Use Node.js 22 or newer:
npm ci --ignore-scripts
npm run checkCI checks Markdown structure, relative file/image links, and Markdown heading fragments. External URLs are not fetched, so provider outages cannot block a documentation change. Review external links and the rendered page when changing them.
Keep existing paths stable. Use relative Markdown links, such as ../sources/telegram.md.
Pages use title and order front matter; index.md is a section's landing page.
Use ordinary Markdown rather than executable MDX components. Repository housekeeping belongs
outside docs/ so it is not published as a product page.
Changes go through a pull request with a passing Docs check before merging. A second person's approval is not required, so a solo maintainer can merge their own checked PR. CI has read-only repository permissions, uses pinned actions and a dependency lockfile, and requires no provider or deployment secrets.
This repository (tryclaire/docs, branch main, folder docs) is the connected source for
docs.tryclaire.net. Merging to main with changes under docs/
enqueues a Claire sync; pages publish without a separate approval step. CI checks the
repository but does not publish anything.
After merging, check Site → Docs sync status and the rendered navigation before announcing a change as live. Do not document rollout-gated features (such as Ethereum/Stockereum availability) as generally available until they are verified in production.
Copyright © 2026 Claire documentation contributors.
The documentation in this repository is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0). You may share and adapt it, including commercially, with attribution to Claire, a link to the license, and an indication of any changes. The license does not grant rights to Claire's trademarks.