read-doc
"Leverage the llmdoc documentation system to quickly understand the project architecture, code details, and key concepts without reading source code directly."
Install
npx skillscat add tokenrollai/cc-plugin/read-doc Install via the SkillsCat registry.
We need to produce a 2-3 sentence plain-text summary, objective, factual, no marketing, no superlatives, no calls to action, natural prose, no bullet points, no headings, no markdown, max 60 words. Must be only the summary text. Let's craft: "The read-doc skill reads a project's llmdoc documentation to provide a summary of its architecture, code details, and key concepts without requiring the user to examine source files directly. It helps developers quickly grasp project structure and available guides when the llmdoc directory is present.
/read-doc
This skill reads the project's llmdoc documentation and provides a comprehensive summary to help understand the project quickly.
Pre-fetched Context
- Doc index: !
cat llmdoc/index.md 2>/dev/null || echo "No llmdoc found" - Doc structure: !
find llmdoc -name "*.md" 2>/dev/null | head -200 || echo "No llmdoc directory"
Actions
Step 1: Check Documentation Exists
- If
llmdoc/directory doesn't exist, inform the user and suggest running/tr:initDocfirst.
- If
Step 2: Read Index
- Read
llmdoc/index.mdto understand the documentation structure.
- Read
Step 3: Read Overview Documents
- Read all documents in
llmdoc/overview/to understand the project's purpose and context.
- Read all documents in
Step 4: Scan Architecture & Guides
- Scan
llmdoc/architecture/for system design information. - Scan
llmdoc/guides/for available workflows.
- Scan
Step 5: Generate Summary
- Provide a concise summary including:
- Project purpose and main features
- Key architectural components
- Available guides and workflows
- Important references
- Provide a concise summary including:
Output the summary directly to the user in a well-structured format.
Install
npx skillscat add tokenrollai/cc-plugin/read-doc Install via the SkillsCat registry.