Skip to content

Add real-world code examples to QUICKSTART.md#25

Merged
lexasub merged 1 commit intomainfrom
feat/issue-3
Mar 9, 2026
Merged

Add real-world code examples to QUICKSTART.md#25
lexasub merged 1 commit intomainfrom
feat/issue-3

Conversation

@lexasub
Copy link
Owner

@lexasub lexasub commented Mar 8, 2026

Summary

Added practical real-world examples to docs/QUICKSTART.md demonstrating common AST-RAG usage patterns for three key scenarios:

  1. Finding All Usages of a Function - Shows how to use ast-rag refs and ast-rag callers for refactoring
  2. Understanding a New Codebase - Demonstrates using semantic search and call graphs to map architecture
  3. Preparing for Refactoring - Provides step-by-step impact analysis workflow

Each example includes:

  • Clear scenario description
  • Practical command sequence
  • Expected result explanation

These examples help developers quickly learn AST-RAG for real-world tasks.

Closes #3

Changes

  • Added new "📚 Real-World Code Examples" section with three detailed examples
  • Each example uses concrete function/class names (processRequest, UserService)
  • Includes both CLI commands and expected outcomes
  • Total addition: ~77 lines of practical guidance

Testing

  • Verified git status and diff
  • Successfully committed with conventional commit message
  • Pushed to feature branch feat/issue-3
  • PR ready for review

Add practical examples showing common AST-RAG usage patterns:
- Finding all usages of a function for refactoring
- Understanding a new codebase quickly
- Preparing for refactoring with impact analysis

Closes #3
@github-project-automation github-project-automation bot moved this to Backlog in raged kanban Mar 8, 2026
@lexasub lexasub merged commit 2b3ac76 into main Mar 9, 2026
1 check failed
@github-project-automation github-project-automation bot moved this from Backlog to Done in raged kanban Mar 9, 2026
@lexasub lexasub deleted the feat/issue-3 branch March 10, 2026 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Add Code Examples to QUICKSTART.md

1 participant