init

CDocs Init

Scaffold the CDocs documentation structure in the current project.

Behavior

1. Create directory structure:

   • cdocs/devlogs/
   • cdocs/proposals/
   • cdocs/reviews/
   • cdocs/reports/
   • cdocs/_media/

2. Generate a lightweight README.md in each document subdir with:

   • A brief description of the doc type's purpose.
   • A format summary (required sections, naming convention).
   • A reference to the full skill: "See /cdocs:<type> for complete authoring guidelines."

3. Create or update .claude/rules/cdocs.md with core CDocs writing conventions. If .claude/rules/ doesn't exist, create it. If the project has a CLAUDE.md, add a reference line: @.claude/rules/cdocs.md

4. If $ARGUMENTS includes --minimal, skip README generation and rules file creation. Only create the bare directory structure.

5. OpenCode detection and rule deployment: If opencode.json exists in the project root OR a .opencode/ directory exists, also perform:

   a. Create .opencode/rules/cdocs/ directory. b. Copy each rule file from the plugin's rules/ directory into .opencode/rules/cdocs/ with OC-enhanced frontmatter prepended:

   ---
   globs:
     - "cdocs/**/*.md"
   keywords:
     - "cdocs"
     - "cdocs devlog"
     - "cdocs proposal"
     - "cdocs review"
     - "cdocs report"
   ---
   

   Strip any existing YAML frontmatter from the source rule file before prepending the OC frontmatter. Add a version comment after the frontmatter: <!-- cdocs rules vX.Y.Z - regenerate with /cdocs:init (use version from plugin.json) --> c. The OC-enhanced frontmatter activates rules conditionally via the opencode-rules plugin: they load only when editing cdocs files or mentioning cdocs-specific terms.

6. AGENTS.md creation (cross-tool fallback): Create or update an AGENTS.md in the project root with inlined rule content (not @-imports, for maximum tool compatibility).

   • If AGENTS.md does not exist, create it with a header and the inlined cdocs rules section.
   • If AGENTS.md already exists, check for <!-- cdocs-rules-start --> / <!-- cdocs-rules-end --> delimiters:
     • If found, replace the content between the delimiters with the current rule content.
     • If not found, append the cdocs rules section at the end of the file.
   • The cdocs rules section uses this structure:

     <!-- cdocs-rules-start -->
     ## CDocs Writing Conventions
     
     [Full content of writing-conventions.md, frontmatter stripped]
     
     ## CDocs Workflow Patterns
     
     [Full content of workflow-patterns.md, frontmatter stripped]
     
     ## CDocs Frontmatter Specification
     
     [Full content of frontmatter-spec.md, frontmatter stripped]
     <!-- cdocs-rules-end -->
     

   • Add a version comment inside the delimiters: <!-- cdocs rules vX.Y.Z - regenerate with /cdocs:init (use version from plugin.json) -->
   • This is idempotent: running init multiple times updates the content between delimiters without duplication.

   NOTE(claude-opus-4-6/cross-target-rules): The inlined content can drift from the source rule files if the plugin is updated but init is not re-run. The version comment helps users identify when regeneration is needed.

README Templates

devlogs/README.md

# Development Logs

Detailed logs of development work.
See `/cdocs:devlog` for complete authoring guidelines.

**Naming:** `YYYY-MM-DD-feature-name.md`

**Key sections:** Objective, Plan, Implementation Notes, Changes Made, Verification.

proposals/README.md

# Proposals

Design and solution proposals.
See `/cdocs:propose` for complete authoring guidelines.
See `/cdocs:rfp` to scaffold a lightweight request-for-proposal stub.

**Naming:** `YYYY-MM-DD-topic.md`

**Full proposals** — BLUF, Objective, Background, Proposed Solution, Design Decisions, Edge Cases, Phases.
**RFP stubs** (`status: request_for_proposal`) — BLUF, Objective, Scope, Open Questions. Elaborate into a full proposal with `/cdocs:propose path/to/stub.md`.

reviews/README.md

# Reviews

Document reviews with structured findings and verdicts.
See `/cdocs:review` for complete authoring guidelines.

**Naming:** `YYYY-MM-DD-review-of-{doc-name}.md`

**Key sections:** Summary Assessment, Section-by-Section Findings, Verdict, Action Items.

reports/README.md

# Reports

Findings, status updates, and analysis.
See `/cdocs:report` for complete authoring guidelines.

**Naming:** `YYYY-MM-DD-topic.md`

**Key sections:** BLUF, Context/Background, Key Findings, Analysis, Recommendations.

Notes

• Do not overwrite existing files. If cdocs/ already exists, only create missing subdirectories and files.
• Use mkdir -p for directory creation (idempotent).
• Check for existing content before writing READMEs to avoid clobbering user modifications.