Documentation (DocFX) – Contentstack Management .NET SDK
When to use
- Regenerating or editing API reference docs.
- Updating
docfx_project/docfx.json, TOC, or filters.
Instructions
Layout
- DocFX project root:
docfx_project/ - Key files:
docfx.json,toc.yml,filterRules.yml,index.md
Metadata source
docfx.jsonmetadata section references project files undersrc/**.csprojin the DocFX config; verify paths match this repo’s layout (core library lives underContentstack.Management.Core/, not necessarilysrc/). Update metadatasrcpaths if doc generation fails after moves.
Build
- Install DocFX per official instructions, then run from
docfx_project(typical:docfx docfx.jsonordocfx build docfx.json). Exact CLI may vary by DocFX version—use the version your team standardizes on.
Relationship to product docs
- End-user NuGet and usage examples stay in root
README.md. DocFX is for API reference material.
DocFX (official).
Source: contentstack/contentstack-management-dotnet — distributed by TomeVault.