write-documentation-guide

To create standardized documentation guides with DocFX, scaffold a new document in docs/guides/{topic-name}-guide.md using the templates/guide-template.md file. This ensures your guide aligns with project conventions and is ready for the DocFX build workflow.

To update cross-references and navigation for existing DocFX guides, modify the content within docs/guides and then update the docs/toc.yml file. Rebuild the DocFX site to verify that all formatting and navigation links work correctly.

The best way to maintain documentation consistency across BookStore projects is to enforce a standardized process using a guide template and DocFX navigation integration. This reduces duplication and onboarding friction by ensuring all guides follow project conventions.

Yes, this DocFX documentation workflow supports updating existing guides within the docs/guides directory. It ensures proper cross-references and navigation updates are applied when modifying API, architectural, or operator documentation.

You need to update docs/toc.yml when adding a new documentation guide to integrate the new page into the project's DocFX navigation. This ensures the guide is accessible in the generated site and cross-references resolve correctly.