Skip to main content

Contributing Docs

Workflow

  1. Create one pull request per feature or tutorial update.
  2. Add or update pages under the correct audience folder in docs/.
  3. Keep screenshots short and task-focused.
  4. Run npm run build locally before requesting review.

Authoring rules

  • Write for customers first, not internal implementation details.
  • Prefer short paragraphs and numbered steps.
  • Use one page per feature tutorial.
  • Link to related audience pages instead of duplicating content.

Naming convention

Use kebab-case filenames that describe the task, for example:

  • create-and-manage-accounts.md
  • submit-assignment.md
  • pay-invoice.md