doc-setup

Create or update the documentation review configuration file interactively.

Setup Process

1. Check Existing Configuration

Use Glob tool to check if .claude/documentation-review.local.md exists.

If config exists:

• Read current configuration using Read tool
• Ask if user wants to update or replace

2. Detect Project Structure

Analyze project to suggest smart defaults:

Documentation Paths

• Check for docs/ directory
• Find README files at various levels
• Locate any .md files

Ignore Patterns

• Detect node_modules/, vendor/, etc.
• Find build output directories
• Identify generated files

Static Site Generator

• Look for mkdocs.yml → MkDocs
• Look for conf.py + Sphinx markers → Sphinx
• Look for docusaurus.config.js → Docusaurus

API Specifications

• Find openapi.yaml, openapi.json
• Find swagger.yaml, swagger.json
• Find asyncapi.yaml

3. Interactive Configuration

Use AskUserQuestion to gather preferences:

Documentation Scope

• Which directories contain documentation?
• Are there files to exclude?
• Should we scan for markdown in source directories?

Quality Standards

• How strict should reviews be?
• Which checks matter most?
• Any custom rules needed?

API Documentation

• Is there an API to document?
• Where is the API spec located?
• Should we generate from code?

Output Preferences

• Preferred verbosity level?
• Output format preference?

4. Generate Configuration

Based on responses, create .claude/documentation-review.local.md:

---
# Documentation Review Configuration
# Generated by /doc-setup on [date]

doc_paths:
  [detected or user-specified paths]

ignore:
  [detected or user-specified patterns]

standards:
  require_description: [true/false]
  max_heading_depth: [number]
  require_code_examples: [true/false]
  check_links: [true/false]
  check_spelling: [true/false]

api_docs:
  openapi_path: [detected or null]
  asyncapi_path: [detected or null]
  generate_from_code: [true/false]

site_generator:
  type: [detected or auto]
  config_path: [detected or null]

output:
  verbosity: [minimal/normal/detailed]
  format: [markdown/json]
---

# Project Documentation Notes

[User can add project-specific context here]