Files
bi-agents/.claude/skills/bmad-index-docs/workflow.md
Cassel 647cbec54f docs: update all documentation and add AI tooling configs
- Rewrite README.md with current architecture, features and stack
- Update docs/API.md with all current endpoints (corporate, BI, client 360)
- Update docs/ARCHITECTURE.md with cache, modular queries, services, ETL
- Update docs/GUIA-USUARIO.md for all roles (admin, corporate, agente)
- Add docs/INDEX.md documentation index
- Add PROJETO.md comprehensive project reference
- Add BI-CCC-Implementation-Guide.md
- Include AI agent configs (.claude, .agents, .gemini, _bmad)
- Add netbird VPN configuration
- Add status report

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-19 13:29:03 -04:00

1.4 KiB

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

# 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