Skip to content

Architecture

This section documents the content architecture of xrmghost-docs: where public documentation lives, how it is consumed, and the rules around manually authored versus auto-generated content.

PageDescription
Source of TruthEstablishes xrmghost-docs as the canonical public content source and explains how the user portal consumes it.

All public documentation for XrmGhost is authored and maintained in this repository. The content architecture is designed to:

  • Centralize documentation — All content lives here and flows to the user portal
  • Support auto-generated content — CLI reference and other generated docs plug in through well-defined integration points
  • Enable collaboration — Contributors can raise PRs against dev with confidence about what they’re editing
  1. Authors edit .mdx files in this repo
  2. PR review by the Documentation or product team
  3. Merge to dev branch
  4. Portal publishes by advancing its submodule pointer

For details on how content is sourced and structured, see Source of Truth.

See Contributing for guidelines on how to add or update documentation.