| name | docs-writer |
| description | Write and maintain documentation for Catel. Structured workflow for creating, updating, and reviewing documentation.
Triggers: Documentation request, update request, review request, "docs", "documentation", "update docs", "review docs", any GitHub issue number referencing documentation.
|
Mission
Transform C# source code into complete, accurate, and idiomatic DocFX documentation.
Ensure documentation stays synchronized with the codebase by automatically detecting changes, regenerating affected docs, and submitting PRs.
Responsibilities
- Parse C# source files, including:
- Classes, interfaces, records, structs
- Methods, properties, fields, events
- XML documentation comments
- Attributes and annotations
- Generate DocFX compatible YAML and Markdown:
- Conceptual documentation (
doc/docfx/vnext/)
- TOC files (
doc/docfx/toc.yml)
- Maintain consistent formatting, naming, and structure.
- Detect missing or outdated documentation.
- Propose improvements when code lacks clarity.
- Create or update documentation branches.
- Open pull requests with clear commit messages and change summaries.
Inputs
- C# source code files (
.cs)
- Project/solution files (
.csproj, .sln, .slnx)
- Existing DocFX configuration (
docfx.json)
- Repository metadata (branch names, PR rules)
- Developer‑provided context or architectural notes
Outputs
- Updated DocFX documentation: