docs-index
Skill44 starsChanged 6 months agoMITView on GitHub
Generate or update the centralized documentation index (docs/INDEX.md) with navigation map and cross-references.
In this repository30 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- agent-creatorSkill
- anti-overengineeringSkill
- audit-docsSkill
- auto-reviewSkill
- architectureSkill
- clean-codeSkill
- commitSkill
- create-docSkill
- dddSkill
- discoverySkill
- e2eSkill
- event-stormingSkill
- implement-featureSkill
- product-managerSkill
- refactor-featureSkill
- refactoring-mikado-stranglerSkill
- review-backSkill
- review-docSkill
- review-followupSkill
- review-frontSkill
- review-fullstackSkill
- securitySkill
- shipSkill
- skill-creatorSkill
- solidSkill
- dashboard-stylingSkill
- tddSkill
- update-docsSkill
- worktreeSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 17
Read .claude/roles/documentalist.md — adopt this profile and follow all its rules.
- Very specific: line 28
Read the frontmatter (title, scope, last-updated)
- Distinctive: line 29
Read the first paragraph (summary)
- Distinctive: line 30
If no frontmatter: use the H1 as title, note "no frontmatter"
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Documentation Index Generator
Activation
This skill activates for:
- Generating or regenerating
docs/INDEX.md - Updating the index after adding/removing docs
/docs-index
Persona
Read .claude/roles/documentalist.md — adopt this profile and follow all its rules.
Workflow
Step 1: Scan Docs
Glob docs/**/*.mdFor each file:
- Read the frontmatter (
title,scope,last-updated) - Read the first paragraph (summary)
- If no frontmatter: use the H1 as title, note "no frontmatter"
Step 2: Generate the Index
Always regenerate from scratch — never patch an existing index.
Target structure for docs/INDEX.md:
---
title: Documentation Index
scope: reference
last-updated: YYYY-MM-DD
---
# Documentation Index
## Quick Navigation
| Document | Scope | Summary | Updated |
|----------|-------|---------|---------|
| [QUICKSTART](./QUICKSTART.md) | guide | 5-minute setup | YYYY-MM-DD |
| [ARCHITECTURE](./ARCHITECTURE.md) | architecture | System overview | YYYY-MM-DD |
| ... | ... | ... | ... |
## By Topic
### Getting Started
1. [QUICKSTART](./QUICKSTART.md)
2. [CONFIG-REFERENCE](./CONFIG-REFERENCE.md)
3. [PROJECT_CONFIG](./PROJECT_CONFIG.md)
### Architecture
- [ARCHITECTURE](./ARCHITECTURE.md)
- [UBIQUITOUS-LANGUAGE](./UBIQUITOUS-LANGUAGE.md)
### MCP Protocol
- [MCP-TOOLS-REFERENCE](./MCP-TOOLS-REFERENCE.md)
### Review System
- [REVIEW-SKILLS-GUIDE](./REVIEW-SKILLS-GUIDE.md)
### Deployment
- [DEPLOYMENT](./DEPLOYMENT.md)
## New Contributor Path
Read in this order:
1. QUICKSTART → 2. ARCHITECTURE → 3. UBIQUITOUS-LANGUAGE → 4. CONFIG-REFERENCEStep 3: Verify Links
For each link in the index, verify the target file exists. Report broken links as errors.
Rules
- The index DOES NOT contain documentary content — only links and one-sentence summaries
- Summaries are extracted from docs, never made up
- Topics are grouped by thematic proximity, not alphabetical order
- The "New Contributor Path" is an ordered reading path, not a simple list
- Files without frontmatter: display a warning
no frontmatterin the Updated column
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

