Welcome to the docs-coderef documentation. This guide is organized into three main sections:
Start here if you want to use the tool:
- Installation - Install and setup
- CLI Usage - Command-line interface
- Configuration - Configuration options
- CODE_REF Syntax - Reference syntax guide
Start here if you want to contribute:
- Getting Started - Setup development environment
- Coding Standards - Style guide and conventions
- Git Conventions - Commit message format
- Testing Guide - Writing and running tests
- Release Process - Release procedures and automation
- Documentation Guidelines - Writing and maintaining docs
Deep dive into technical implementation:
- Architecture Overview - System design and module structure
- CODE_REF Syntax Implementation - AST parsing and symbol search
- Testing Strategy - Test configuration and coverage
- Main README - Project homepage
- CLAUDE.md - AI assistant guidance
- CHANGELOG - Version history
docs/
├── README.md (this file)
├── user-guide/ # End-user documentation
├── development/ # Contributor guides
└── architecture/ # Technical deep-dives