Skip to main content

Contributing

  1. Read copilot-instructions.md and MULTI_TENANT_DESIGN_V2.md.
  2. Write a short design spec in specs/<feature>_design.md (goal, acceptance criteria, frontend/backend/security perspectives).
  3. Implement with tests: backend npm test (Node test runner), frontend npx vitest run --coverage (≥ 90 % lines).
  4. Fill in the pull-request template — including the Documentation Definition of Done.
  5. Never push to main directly: pushing to main deploys production.

Working on these docs​

cd docs-site
npm ci
npm start            # English
npm run start:hi     # Hindi
npm run build        # what CI runs; broken links fail the build
  • Pages are Markdown/MDX under docs-site/docs/. Hindi translations live under docs-site/i18n/hi/docusaurus-plugin-content-docs/current/ with the same file path; missing pages fall back to English.
  • Keep doc ids stable — in-app help links to them.
  • Link to other docs with relative file links (../modules/appointments.md) except when the target page has a Hindi translation: then use the absolute doc URL (/docs/roles). Docusaurus cannot resolve file links from an untranslated (English fallback) page to a translated page in the hi build.
  • Wrap literal braces in code spans (MDX treats bare curly braces as expressions).