skills.rest
contentstack
contentstackOFFICIAL
Explore all skills by this author →
WebsiteGitHub

documentation

Regenerate DocFX API documentation from code annotations and metadata.

2|4|Updated Jun 30, 2021
Search Tags:#csharp#documentation#api#doc-generation#docfx#documentation-tooling
One-click install
npx skills add https://github.com/contentstack/contentstack-management-dotnet --skill documentation-contentstack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/contentstack/contentstack-management-dotnet/tree/main/skills/documentation
Command: npx skills add https://github.com/contentstack/contentstack-management-dotnet --skill documentation-contentstack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Regenerating or updating DocFX API documentation for this repository to ensure API references are accurate and up-to-date.

Core Features & Use Cases

  • Regenerates API reference docs from code annotations and metadata.
  • Updates docfx_project/docfx.json, toc.yml, and filterRules.yml to reflect code changes.
  • Ensures metadata sources align with repository structure to prevent broken links in docs.

Quick Start

Run docfx build from the docfx_project directory to generate the API reference documentation.

Frequently Asked Questions about documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I regenerate API documentation using DocFX for my repository?▼

To regenerate API documentation using DocFX, you run the docfx build command from the docfx_project directory to generate updated API references from your code annotations and metadata.

What is the process for updating docfx.json and toc.yml after code changes?▼

Updating docfx.json and toc.yml involves modifying these files within the docfx_project to ensure metadata sources align with the repository structure and accurately reflect recent code changes.

Do I need DocFX installed before generating API reference docs?▼

Yes, you need DocFX installed and configured, and your project sources must be accessible under the docfx_project folder to successfully build and generate API reference documentation.

How does DocFX prevent broken links in API documentation?▼

DocFX prevents broken links by ensuring metadata sources within docfx.json and filterRules.yml strictly align with the current repository layout before regenerating the API reference documentation.

Can I generate C# API docs directly from code annotations?▼

Yes, you can generate C# API docs directly from code annotations by running a DocFX build, which extracts metadata from the source code to create accurate API reference documentation.

Why does my DocFX build fail to locate metadata sources?▼

A DocFX build fails to locate metadata sources when the paths configured in docfx.json do not align with the actual repository layout, preventing successful generation of API documentation.

Related Skills

Explore More Software Engineering Skills→
AGIBuildAGIBuild
10

dotnet-api-docs

Generate .NET API documentation with DocFX and OpenAPI specifications.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
dimsourdimsour
2

document

Generate XML doc comments, READMEs, and OpenAPI descriptions from .NET source code.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate