Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Conversation

@scottsen
Copy link
Owner

No description provided.

- Update claude.md to reference current doc locations instead of archived files
  - ARCHITECTURE.md -> docs/architecture/overview.md
  - AUDIO_SPECIFICATION.md -> docs/specifications/ambient-music.md
- Make git branch instructions generic (not tied to specific branch)
- Move KAIRO_RENAME_QUICK_REFERENCE.txt to docs/archive/historical/
  (historical context about project rename)
## reveal tool (scripts/)
- Add reveal.py: Local Python implementation (no external dependencies)
  - Level 0: Metadata (size, lines, hash)
  - Level 1: Structure (imports, classes, functions for .py; headings for .md)
  - Level 2: Preview (beginning + middle + end samples)
  - Level 3: Full content with line numbers
- Update reveal.sh: Falls back to local reveal.py if external tool not installed
- Update scripts/README.md: Document reveal.py features and usage

## Documentation index (docs/)
- Add DOCUMENTATION_INDEX.md: Comprehensive index of all 90+ documentation files
  - Root-level docs mapped with sizes and key sections
  - All subdirectories cataloged (architecture, specifications, guides, etc.)
  - Navigation tips and reveal tool examples
  - Quick reference tables for specifications and ADRs
- Update docs/README.md: Reference new documentation index and reveal tool

## Benefits
- Progressive file exploration conserves tokens (5-30% vs full read)
- Self-contained tool works immediately with Python 3
- Complete documentation map for navigation
- Examples of using reveal to explore codebase
@scottsen scottsen merged commit 3b4b3ef into master Nov 21, 2025
2 of 26 checks passed
@scottsen scottsen deleted the claude/organize-documents-017aaAL35F8nqPxghzJX4REH branch November 21, 2025 19:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants