context:generate-docs-index

Included with Lifetime

$97 forever

Internal documentation-index generation workflow for direct invocation from context maintenance tasks.

Code Review

What this skill does


# generate-docs-index

Auto-generate `docs/index.md` as a table of contents for the `docs/` directory.

## Philosophy

From devkit:standards — "Make documentation auto-generatable — hand-maintained docs always go stale."

`docs/index.md` must be fully derivable from the file system. Never hand-edit it.

## Execution

### 1. Scan

Glob `docs/**/*.md` excluding `docs/index.md` itself and any `node_modules/`.

### 2. Extract Metadata

For each file:

- **Path**: relative from project root (e.g. `docs/api/mutils.md`)
- **Title**: first `# heading` in the file. If none, use the filename without extension

### 3. Group by Directory

Group files by their parent directory under `docs/`:

- `docs/*.md` → top-level (no group header)
- `docs/api/*.md` → "API Reference" (derive display name from directory: kebab-case → Title Case)
- `docs/guides/*.md` → "Guides"
- etc.

Sort groups alphabetically. Within each group, sort files alphabetically.

### 4. Generate docs/index.md

Write the file with this structure:

```markdown
# Documentation Index

> Auto-generated. Do not edit manually.

## [Group Name]

| Document                  | Description                                          |
| ------------------------- | ---------------------------------------------------- |
| [Title](relative/path.md) | First non-heading paragraph (truncated to ~80 chars) |
```

- Top-level files (directly under `docs/`) appear first, without a group header
- Description: extract the first non-empty, non-heading line after the title. Truncate at 80 characters with `...` if longer. If no description found, leave empty
- Links use paths relative to `docs/` (e.g. `api/mutils.md`, not `docs/api/mutils.md`)

### 5. Write Only If Changed

Compare generated content with existing `docs/index.md`. Write only if different. Report whether the file was updated or already in sync.

## Integration

This skill should be invoked:

- After running `refactor-project-context` if docs were modified
- When the user adds or reorganizes documentation
- As part of any documentation audit workflow

Files: 1

Size: 2.2 KB

Complexity: 10/100

Category: Code Review

Source: https://github.com/masseater/claude-code-plugin/tree/main/plugins/context/skills/generate-docs-index

Related in Code Review

gstack

Included

Fast headless browser for QA testing and site dogfooding. Navigate pages, interact with elements, verify state, diff before/after, take annotated screenshots, test responsive layouts, forms, uploads, dialogs, and capture bug evidence. Use when asked to open or test a site, verify a deployment, dogfood a user flow, or file a bug with screenshots. (gstack)

Code Reviewscriptsfeatured

startup-due-diligence

Included

Legal due diligence review for seed-stage and Series A startups (US, Delaware C-Corp focus). Supports both investor and founder perspectives. Capabilities include: (1) Interactive document review and issue spotting; (2) Document request list generation; (3) Cap table and SAFE/convertible note analysis; (4) Red flag identification with severity ratings; (5) Diligence report generation. TRIGGERS: due diligence, DD, startup investment, cap table review, Series A, seed round, investor diligence, legal review startup, SAFE analysis, convertible note, 409A, founder vesting.

Code Reviewscripts

interview-master

Included

This skill should be used when the user asks to "generate interview questions", "prepare for interview", "optimize resume", "conduct mock interview", "analyze git commits for resume", "generate resume from code", "review my resume", or mentions interview preparation, career assistance, or extracting project experience from git history. Provides comprehensive interview and career development guidance for both job seekers and interviewers.

Code Reviewscripts

fix-issue

Included

Fixes GitHub issues using parallel analysis agents for root cause investigation, code exploration, and regression detection. Reads issue context from gh CLI, searches codebase and memory for related patterns, generates a fix with tests, and links the resolution back to the issue via PR. Includes prevention analysis to avoid recurrence. Use when debugging errors, resolving regressions, fixing bugs, or triaging issues.

Code Reviewscripts

sf-apex

Included

Generates and reviews Salesforce Apex code with 150-point scoring. TRIGGER when: user writes, reviews, or fixes Apex classes, triggers, test classes, batch/queueable/schedulable jobs, or touches .cls/.trigger files. DO NOT TRIGGER when: LWC JavaScript (use sf-lwc), Flow XML (use sf-flow), SOQL-only queries (use sf-soql), or non-Salesforce code.

Code Reviewscripts

swift-development

Included

Comprehensive Swift development for building, testing, and deploying iOS/macOS applications. Use when Claude needs to: (1) Build Swift packages or Xcode projects from command line, (2) Run tests with XCTest or Swift Testing framework, (3) Manage iOS simulators with simctl, (4) Handle code signing, provisioning profiles, and app distribution, (5) Format or lint Swift code with SwiftFormat/SwiftLint, (6) Work with Swift Package Manager (SPM), (7) Implement Swift 6 concurrency patterns (async/await, actors, Sendable), (8) Create SwiftUI views with MVVM architecture, (9) Set up Core Data or SwiftData persistence, or any other Swift/iOS/macOS development tasks.

Code Reviewscripts