mo-docs-authoring

Generate zh-CN Monica module documentation from repository source files.

13|6|Updated Feb 19, 2025
One-click install
npx skills add https://github.com/Tairitsua/Monica --skill mo-docs-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mo-docs-authoring
Source: https://github.com/Tairitsua/Monica/tree/main/.claude/skills/mo-docs-authoring
Command: npx skills add https://github.com/Tairitsua/Monica --skill mo-docs-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provide a repeatable, source-grounded workflow to create, revise, and migrate Monica user documentation so that published docs match the current code and follow Monica conventions, reducing stale or inconsistent guidance.

Core Features & Use Cases

  • Classify the documentation target as a framework page, concept page, module documentation pack, or scenario guide and choose the appropriate output shape.
  • Rebuild truth from source using a strict checklist that inspects project files, module registration, public abstractions, module options, and ModuleGuide requirements.
  • Apply Monica writing rules and templates to produce zh-CN documentation by default, including module doc packs, quick starts, configuration references, and guide-and-provider pages.
  • Revise existing Monica.Docs pages in place when they conflict with source, enforce Mo.Add*() registration names, and generate file-path-based slugs for discoverability.

Quick Start

Use mo-docs-authoring to draft a zh-CN module documentation pack for the Example module grounded in the repository source and the module doc pack template.

Frequently Asked Questions about mo-docs-authoring

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

FAQPage Schema
How do I generate standardized zh-CN module documentation from C# source files?

To generate zh-CN module documentation, parse repository csproj and Modules/Module*.cs files to extract Mo.Add* registration names, ModuleOption defaults, and ModuleGuide methods, then write validated markdown following Monica templates into the docs directory.

What is the best way to migrate existing Monica documentation to match current code?

Migrating Monica documentation involves rebuilding truth from source by inspecting project files and module registration, enforcing Mo.Add*() registration names, and revising existing markdown pages in place to resolve conflicts with current source code.

How do I create a quick-start guide for a Monica framework module?

Creating a quick-start guide requires classifying the target as a framework or module page, extracting required setup keys and public abstractions from source files, and applying Monica writing rules to produce the zh-CN markdown output.

What source files do I need to read for Monica docs authoring?

Monica docs authoring requires reading project csproj files and Modules/Module*.cs files to extract Mo.Add* registration names, ModuleOption defaults, ModuleGuide methods, and required setup keys for accurate documentation generation.

When should I use a module doc pack instead of a scenario guide for Monica documentation?

Use a module doc pack when documenting a specific module's configuration references and provider guides, and use a scenario guide when writing cross-module recipes that combine multiple Monica modules within a single workflow.

Can I generate file-path-based slugs for Monica documentation discoverability?

Yes, generating file-path-based slugs is supported during the markdown authoring process to enforce discoverability and ensure consistent organization within the Monica.Docs directory structure.