Skip to main content

Documentation Contributions

Workflow​

  1. Identify the product area or code behavior being documented.
  2. Confirm the source of truth in code, configuration, existing docs, or product owner guidance.
  3. Add or update the relevant Markdown or MDX page in xtrakt.doc/docs.
  4. Link the page from nearby docs.
  5. Run the documentation build.
  6. Ask for review from the owner of the product area.

Validation​

cd xtrakt.doc
npm run build

Review Standard​

Documentation should be clear enough for a new user, developer, administrator, or operator to take the next step without reading source code first.