julian
17c08e6392
- Nx 22.7 monorepo (pnpm 11.1, TypeScript 5.9, Node 24) - apps/api: NestJS 11 (CJS conforme CODING-RULES.md PGD-DB-004) - apps/web: React 19 + Vite 8 (ESM) - libs/shared/api-interface: Zod contract base - Docker Compose dev: Postgres 18, Valkey 8, MinIO, Mailpit - WDS artifacts: - design-artifacts/A-Product-Brief/ (5 docs canônicos + 16 dialogs) - design-artifacts/B-Trigger-Map/ (hub + 4 personas + feature impact) - Stack canon: STACK.md v2.2 + CODING-RULES.md v2.0 + brand.md - AGENTS.md + README.md como entrada para devs/agentes Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
67 lines
1.6 KiB
Markdown
67 lines
1.6 KiB
Markdown
---
|
|
name: bmad-index-docs
|
|
description: 'Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder'
|
|
---
|
|
|
|
# Index Docs
|
|
|
|
**Goal:** Generate or update an index.md to reference all docs in a target folder.
|
|
|
|
|
|
## EXECUTION
|
|
|
|
### Step 1: Scan Directory
|
|
|
|
- List all files and subdirectories in the target location
|
|
|
|
### Step 2: Group Content
|
|
|
|
- Organize files by type, purpose, or subdirectory
|
|
|
|
### Step 3: Generate Descriptions
|
|
|
|
- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
|
|
|
|
### Step 4: Create/Update Index
|
|
|
|
- Write or update index.md with organized file listings
|
|
|
|
|
|
## OUTPUT FORMAT
|
|
|
|
```markdown
|
|
# Directory Index
|
|
|
|
## Files
|
|
|
|
- **[filename.ext](./filename.ext)** - Brief description
|
|
- **[another-file.ext](./another-file.ext)** - Brief description
|
|
|
|
## Subdirectories
|
|
|
|
### subfolder/
|
|
|
|
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
|
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
|
|
|
### another-folder/
|
|
|
|
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
|
```
|
|
|
|
|
|
## HALT CONDITIONS
|
|
|
|
- HALT if target directory does not exist or is inaccessible
|
|
- HALT if user does not have write permissions to create index.md
|
|
|
|
|
|
## VALIDATION
|
|
|
|
- Use relative paths starting with ./
|
|
- Group similar files together
|
|
- Read file contents to generate accurate descriptions - don't guess from filenames
|
|
- Keep descriptions concise but informative (3-10 words)
|
|
- Sort alphabetically within groups
|
|
- Skip hidden files (starting with .) unless specified
|