Add Real-World Project: Codebase Q&A — Where Is X Implemented? - #275
Open
abderrahim-lectures wants to merge 1 commit into
Open
Add Real-World Project: Codebase Q&A — Where Is X Implemented?#275abderrahim-lectures wants to merge 1 commit into
abderrahim-lectures wants to merge 1 commit into
Conversation
New Real-World Project (backlog idea #18). Full lesson plus a runnable tool that answers 'where is X defined?' with an exact ast symbol index and 'how does X work?' with embedding search, grounding a free-tier LLM in file:line citations. Closes #274 Co-authored-by: deepseek-v4-flash-free <noreply@opencode.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new Real-World Projects lesson: Build a Codebase Q&A Tool — Where Is X Implemented? (backlog idea #18).
What's included
docs/projects/codebase-qa/index.md— full lesson in the house skeleton. Core idea: 'where is X implemented?' is two different questions, answered with two deliberately separate indexes — an exactast-based symbol index (functions/classes/methods/imports + line numbers) and a semantic embedding index — plus a dispatcher that routes between them, falls through honestly, and grounds LLM answers in verifiablefile:linecitations.docs/projects/codebase-qa/_category_.jsonexamples/codebase-qa/— runnable tool:symbols.py,prepare_repo.py,build_index.py,retrieve.py,query.py(6-provider LLM support), a bundledsample_repo/(tiny training pipeline),notebook.ipynb, README, pyproject/uv.lock.src/data/projects.ts,docs/projects/index.mdx,src/pages/index.tsx(English only — i18n in a follow-up PR).Verification
query.py "where is split_data defined?"returns the exact hit without an API key; a made-up symbol triggers the documented fallthrough; retrieval returns score-ranked chunks with citations.npm run typecheckandnpm run buildpass (all 4 locales, no broken links).Closes #274