Skip to main content

How to Submit Documentation

Purpose​

This guide details how to write, edit, test, and submit documentation updates to the Chambey Docs repository.

Summary​

Our documentation is built using Docusaurus. Updates are submitted by editing Markdown or MDX files in the docs folder. To maintain quality and structure, all documentation submissions should follow the standardized page templates.

Who This Is For​

  • Ecosystem Writers & Maintainers: Authoring or correcting content.
  • Developers: Documenting new features, APIs, or smart contract rules.

Key Details​

  • Markdown & MDX: We support standard markdown formatting along with React components within .mdx files.
  • Standardized Template: Every new documentation page must include the 6 standard headers (Purpose, Summary, Who This Is For, Key Details, Next Steps, Related Pages).
  • Navigation Placement: When adding a page, configure the sidebar_position metadata in the frontmatter or update the folder's _category_.json file.

Next Steps​

  • Fork the documentation repository and edit/create pages.
  • Run npm run build locally to verify there are no broken links before submitting your PR.