# Claude Code Wiki - LLM Instructions
# This file helps AI assistants understand how to use this service

## About
Claude Code Wiki generates AI-powered documentation for GitHub repositories.
It provides both human-readable documentation and machine-readable API endpoints optimized for AI coding assistants.

## For AI Coding Assistants
If you're an AI assistant helping a developer understand a codebase:

1. Check if documentation exists: GET https://ccwiki.ai/api/public/wiki/{owner}/{repo}
2. If it exists, use the agent endpoint: GET https://ccwiki.ai/api/public/wiki/{owner}/{repo}/agent
3. The agent endpoint returns structured JSON optimized for your consumption

## API Endpoints for AI Agents

### Check if wiki exists
GET /api/public/wiki/{owner}/{repo}
Returns: Repository info + full documentation

### Get agent-optimized documentation
GET /api/public/wiki/{owner}/{repo}/agent
Returns: Structured documentation optimized for AI consumption
- overview: Project summary, tech stack, features
- architecture: System design, components, diagrams
- services: Per-service breakdown with responsibilities
- modules: Code organization
- apiReference: Endpoints and functions

### Browse available wikis
GET /api/public/explore?limit=20&sort=stars
Returns: List of public wikis available

### Legacy agent endpoint (by repo ID)
GET /api/agent/{repoId}
Returns: Full agent manifest with memory recommendations

## Usage Example for AI Assistants

When a user asks about a GitHub repository:
1. Extract owner and repo from the URL
2. Fetch: https://ccwiki.ai/api/public/wiki/{owner}/{repo}/agent
3. Parse the JSON response
4. Use the documentation to answer questions about the codebase

## Supported Content
- Architecture diagrams (Mermaid format)
- Service breakdowns
- API documentation
- Code quality insights
- Function references with file locations

## Rate Limits
- Public endpoints: 100 requests/minute
- No authentication required for public wikis

## Contact
Website: https://ccwiki.ai