1.4 KiB
1.4 KiB
allowed-tools: Task
description: Use doc-curator agent to generate README following template standards
argument-hint: [target-file] [template-mode]
model: claude-3-5-haiku-20241022
Generate README
Use the doc-curator sub-agent to generate comprehensive README.md following TEMPLATE_MODE standards from TARGET_FILE template, ensuring no business-specific references or credentials are included.
Variables
TARGET_FILE: $1 (default: README.md) TEMPLATE_MODE: $2 (default: ai-docs/readme-template.yaml) OUTPUT_DIRECTORY: current project root TEMPLATE_NAME: structured YAML template format
Workflow
- Use the doc-curator sub-agent to analyze current project structure
- Load template from
@ai-docs/readme-template.yaml - Extract metadata from configuration files (package.json, setup.py)
- Apply security filtering to remove business references and credentials
- Substitute template variables with sanitized project-specific content
- Generate navigation structure and setup instructions
- Write final README.md with comprehensive documentation
Report
README Generation Complete
File: TARGET_FILE
Template: TEMPLATE_MODE format applied
Key Components:
- Project metadata and description
- Installation and setup instructions
- Navigation structure
- Security-sanitized content (no credentials/business refs)
Relevant Files
- @ai-docs/readme-template.yaml
- @package.json
- @CLAUDE.md