Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ jobs:

echo "✅ Safeguard validation passed: $AFTER files present"

- name: Build search index
if: steps.validate-safeguard.outputs.safeguard_triggered != 'true'
run: |
echo "Building full-text search index..."
python scripts/build_search_index.py
echo "Search index built successfully"

- name: Check for changes
id: verify-changed-files
run: |
Expand All @@ -103,7 +110,7 @@ jobs:
id: commit-msg
run: |
# Stage changes to see what will be committed
git add -A docs/
git add -A docs/ paths_manifest.json

# Get list of changed files with proper quoting
# Using printf with %q for shell-safe quoting would be ideal, but not available in all shells
Expand Down
12 changes: 6 additions & 6 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ The docs are periodically updated via GitHub Actions with safeguards to prevent
This repository uses a **graceful degradation** approach:

**Installation** (always the same):
- 573 documentation paths tracked in manifest (6 categories)
- 571 files downloaded
- Documentation paths tracked in manifest (6 categories)
- Documentation files downloaded
- Python scripts for enhanced features
- Full test suite (294 tests) and GitHub workflows

Expand Down Expand Up @@ -395,7 +395,7 @@ When Python 3.9+ is installed, these additional capabilities are available:
- **Full-text search**: `--search "keyword"` searches across all documentation content
- **Category filtering**: `--category api` lists paths in specific categories
- **Path validation**: `--validate` checks documentation integrity
- **Active documentation**: Access to 573 paths across 6 categories:
- **Active documentation**: Access to paths across 6 categories:
- API Reference (377 paths, 65.8%) - Includes multi-language SDK docs (Python, TypeScript, Go, Java, Kotlin, Ruby)
- Core Documentation (82 paths, 14.3%)
- Prompt Library (65 paths, 11.3%)
Expand All @@ -409,7 +409,7 @@ See `enhancements/` directory for comprehensive feature documentation and exampl

```
/
├── docs/ # 571 documentation files (.md format)
├── docs/ # Documentation files (.md format)
│ ├── docs_manifest.json # File tracking manifest
│ └── .search_index.json # Full-text search index (Python-generated)
├── scripts/
Expand All @@ -434,7 +434,7 @@ See `enhancements/` directory for comprehensive feature documentation and exampl
│ ├── validation.py # Path validation
│ ├── formatting.py # Output formatting
│ └── cli.py # Main entry point
├── paths_manifest.json # Active paths manifest (573 paths, 6 categories)
├── paths_manifest.json # Active paths manifest (6 categories)
├── archive/ # Archived/deprecated scripts (git-ignored)
├── enhancements/ # Feature documentation
│ ├── README.md # Overview
Expand Down Expand Up @@ -464,7 +464,7 @@ When working on this repository:
@scripts/fetcher/ - Documentation fetching package (8 modules)
@scripts/lookup/ - Search & validation package (7 modules)
@scripts/build_search_index.py - Full-text search indexing
@paths_manifest.json - Active paths manifest (573 paths, 6 categories)
@paths_manifest.json - Active paths manifest (6 categories)
@tests/ - Test suite (294 tests)

### Automation
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@

**Fast, searchable access to Claude Code documentation - locally, always up-to-date.**

Stop hunting through scattered docs. This tool provides instant access to **573 actively maintained** Claude documentation paths covering API references, guides, examples, and changelogs.
Stop hunting through scattered docs. This tool provides instant access to **actively maintained** Claude documentation paths covering API references, guides, examples, and changelogs.

## Key Features

- 🤖 **AI-Powered Search** - Ask questions naturally, Claude understands intent and routes intelligently
- 📚 **Complete Coverage** - 573 documentation paths tracked, 571 files downloaded
- 📚 **Complete Coverage** - documentation paths tracked and files downloaded
- 🔍 **Semantic Understanding** - No primitive keyword matching, leverages Claude's language understanding
- ✅ **Auto-Validated** - Continuous validation detects broken links automatically
- 🔄 **Always Fresh** - Repository updated every 3 hours; run `/docs -t` to pull latest
Expand All @@ -42,7 +42,7 @@ The magic is in combining a simple local file system with Claude's language unde

## What's Included

**Documentation Paths** (573 tracked in manifest across 6 categories):
**Documentation Paths** (tracked in manifest across 6 categories):
- API Reference (377 paths, 65.8%) - Complete API docs, Admin API, Agent SDK
- 🐍 **Python** (45 docs) | 📘 **TypeScript** (45 docs) | 🔷 **Go** (45 docs)
- ☕ **Java** (45 docs) | 🟣 **Kotlin** (45 docs) | 💎 **Ruby** (45 docs)
Expand All @@ -56,7 +56,7 @@ The magic is in combining a simple local file system with Claude's language unde

> 🚀 **No Python required!** Core features including AI-powered semantic search work with just bash. Python 3.9+ enables advanced full-text search and path validation.

**Files Downloaded** (571 actual .md files)
**Files Downloaded** (matching .md files)

**Optional Python Features** (requires Python 3.9+):
- Full-text content search (`--search-content`)
Expand All @@ -75,7 +75,7 @@ curl -fsSL https://raw.githubusercontent.com/costiash/claude-code-docs/main/inst

**What it does:**
1. Clones repository to `~/.claude-code-docs`
2. Installs 571 documentation files
2. Installs documentation files
3. Sets up `/docs` command in Claude Code
4. Verifies installation integrity

Expand Down Expand Up @@ -129,8 +129,8 @@ The installer will:

| Metric | v0.4.x | v0.5.0 |
|--------|--------|--------|
| Documentation Files | ~270 | 571 |
| Tracked Paths | 273 | 573 |
| Documentation Files | ~270 | 570+ |
| Tracked Paths | 273 | 570+ |
| Python Modules | Monolithic | Modular (15 modules) |
| Safety Thresholds | None | 3 safeguards |

Expand Down Expand Up @@ -228,7 +228,7 @@ The installer will:
For power users who want direct access to helper functions:

```bash
# Fuzzy search across 573 paths (requires Python 3.9+)
# Fuzzy search across all paths (requires Python 3.9+)
~/.claude-code-docs/claude-docs-helper.sh --search "keyword"

# Full-text content search (requires Python 3.9+)
Expand All @@ -249,8 +249,8 @@ For power users who want direct access to helper functions:
## Architecture

**Single Installation** - Always installs complete repository:
- 573 documentation paths tracked in manifest (6 categories)
- 571 files downloaded
- Documentation paths tracked in manifest (6 categories)
- Documentation files downloaded
- Modular Python packages for enhanced features
- Full test suite (294 tests)

Expand Down
Loading
Loading