Skip to content

Contributing

Thank you for improving Fisoma docs.

Scope

Prefer accurate, short pages. If something is unknown, mark it as a TODO for the team instead of guessing.

Language

  • Published markdown body: English
  • Do not commit secrets, tokens, or contents from secret/config-custom.env

Edit and preview

bash
cd docs
npm install
npm run dev
  • Add app pages under apps/<app>/...
  • Put screenshots and videos in apps/<app>/assets/
  • Register new routes in .vitepress/config.mjs (nav / sidebar)

Style

  • One job per page: clear title, short intro, tables for maps, Mermaid for architecture
  • Link to sibling pages instead of duplicating long explanations

Verify before you open a PR

bash
npm run build

Build must succeed.

Last updated: