Content Ownership

Content Ownership

This page defines who owns each section of the public XrmGhost documentation and how updates flow through to the user portal.

Ownership Table

Docs Section	Path	Owning Repo	Owning Team	Update Process
Getting Started	src/content/docs/getting-started.mdx	xrmghost-docs	Documentation / DevRel	Edit MDX in this repo, raise PR, merge to dev
CLI Narrative	src/content/docs/cli/index.mdx, src/content/docs/cli/getting-started.mdx	xrmghost-docs	Documentation / CLI team	Edit MDX in this repo, raise PR to xrmghost-docs
CLI Reference (generated)	src/content/docs/cli/reference/	xrmghost-cli (source); xrmghost-docs (output)	CLI team	Changes go to xrmghost-cli; generator publishes output here — see Generated vs Manual
Attributes Reference	src/content/docs/attributes/	xrmghost-docs (narrative); xrmghost-attributes (schema)	Attributes team + Documentation	Same split as CLI: narrative here, schema-derived content future
Architecture	src/content/docs/architecture/	xrmghost-docs	Architecture / Engineering	PR to this repo; engineering review recommended
Contributing Guidelines	src/content/docs/contributing/	xrmghost-docs	Engineering / Developer Experience	PR to this repo

CLI Ownership Boundary

The CLI docs surface has two distinct ownership zones that must not be conflated:

CLI Narrative Content (src/content/docs/cli/index.mdx, src/content/docs/cli/getting-started.mdx)

• Owned by: Documentation team in xrmghost-docs.
• Change process: Open a PR against xrmghost-docs. At least one reviewer from the Documentation or CLI team approves.
• Do not: Touch src/content/docs/cli/reference/ files from a narrative-only PR. Narrative and generated paths are separate surfaces.

Generated CLI Reference (src/content/docs/cli/reference/)

• Owned by: CLI team in xrmghost-cli (the source of truth). The files that appear under docs/cli/reference/ are outputs, not the authoritative source.
• Change process: Raise a PR or workstream in xrmghost-cli to change the CLI command, its --help output, or the command manifest. The generator then re-publishes updated reference files to src/content/docs/cli/reference/.
• Approval authority: Review and approval live in xrmghost-cli. Approving a change to a generated file in xrmghost-docs directly is not a valid review path.
• Do not: Manually edit files under src/content/docs/cli/reference/. See Generated vs Manual for the full CLI generation contract.

xrmghost-user-portal Role

xrmghost-user-portal consumes the documentation from xrmghost-docs. It is not an authoring surface. The portal team advances its submodule pointer or runs a sync script after changes merge to dev in xrmghost-docs. The portal never becomes the source of truth for any documentation content.

Update Process Detail

For narrative / manually authored content

1. Author edits the relevant .mdx file(s) in this repo.
2. Author opens a pull request against the dev branch.
3. At least one reviewer from the owning team approves.
4. Merge to dev.
5. Portal team advances the submodule pointer (or runs the sync script) to publish.

For generated CLI reference content (future)

TODO (ADO-1175): Implement the exact pipeline automation once the xrmghost-cli generator is built. The steps below describe the intended flow:

1. CLI team makes source changes (command definition, --help text, or manifest) in xrmghost-cli and merges through that repo’s review process.
2. Generation pipeline runs against the updated xrmghost-cli artifact.
3. Generated MDX files land under src/content/docs/cli/reference/ in xrmghost-docs via an automated commit or PR.
4. Generated files are not manually edited. If the output is wrong, fix the source in xrmghost-cli.
5. Portal team advances submodule pointer after generated content lands in dev.

See Generated vs Manual for the full CLI generation contract.

Notes

• Cross-cutting changes (e.g., a rename that affects multiple sections) should be coordinated by the Documentation team.
• If a section’s owning team is unclear, default to the Documentation team as interim owner.
• xrmghost-user-portal, xrmghost-cli, and xrmghost-attributes are not edited from this repo. Content references to those products are narrative descriptions only.