docs: Sync docs and agent workflows to completed stack#11
Merged
Conversation
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
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.
Summary
Root README, backend README, and
backend/.env.examplewere updated to reflect the fully-implemented pipeline: LLM feedback correctly attributed to Groq (openai/gpt-oss-20b), both/feedback/generateand/feedback/generate-sessionmarked done with full request/response documentation, scorecard components and lib helpers added to the repo structure, deploy rows changed to TBD, and the.env.exampleheader corrected to stop stating all three keys are required. All eight agent workflow documents were revised to remove patterns inapplicable to this project — Next.js Route Handlers, Zod, E2E tests,pnpm testrunner, flag registry, and DB query references — and to add Interview Coach–specific guidance covering FastAPI endpoint patterns, Storybook as the primary coverage mechanism, both feedback modes in QA checklists, and project-accurate file paths throughout.What was corrected
README.md,backend/README.mdbackend/.env.examplepnpm test, flag registry, DB queries)File-by-file changes
Root documentation
README.md: Removed "(Coming)" from steps 8–9, corrected LLM provider from "Anthropic Claude (coming)" to "Groq (openai/gpt-oss-20b)", added Node.js 18+ prerequisite, expanded repo structure with all implemented scorecard components and lib helpers, changed deploy rows to TBD, and added a full backend endpoints table to reflect the completed pipeline state.Backend documentation
backend/.env.example: Changed line 3 header from "All three keys are required for the full pipeline to function" to accurately state that onlyGROQ_API_KEYis required and the remaining keys are reserved, eliminating a contradiction with the per-key comments below it.backend/README.md: Marked/feedback/generateas done, added/feedback/generate-sessionas done, updated structure section with both LLM endpoints andschemas.py, and added full request/response documentation blocks for both feedback endpoints matching the Pydantic schemas inbackend/services/llm/schemas.py.Agent workflows
docs/agent-workflows/branch-change-impact-audit.md: Renamed "Feature-flag involvement" to "Env-var or behavioral mode changes" and scoped the trigger toNEXT_PUBLIC_*behavioral gating only, becausefeatureFlag/featureGatepatterns do not exist in this project.docs/agent-workflows/code-quality-review.md: Removed theawait in API route handlersbullet and Zod validation check (no Route Handlers exist), replaced with a FastAPI-specific client-sidefetcherror handling check; removed Priority 10 (new API route security) entirely; updated Priority 4 to reference Pydantic/types.tsinstead of Zod; scopedpnpm testinstruction to "not configured — skipped."docs/agent-workflows/feature-flag-gating-review.md: Added a "Project context (Interview Coach)" section stating no formal flag system exists, defining when to apply the workflow (NEXT_PUBLIC_*behavioral gating or complex mode branches), and noting the flag registry check does not apply.docs/agent-workflows/feature-implementation-planning.md: Updated plan item 2 to name external services (Groq Whisper, Orpheus, LLM, wav2vec2); replaced generic file manifest groupings with actual project paths (backend/services/<service>/router.py,schemas.py,lib/interview-coach/,lib/speech/, etc.); added feedback mode verification to item 6.docs/agent-workflows/figma-design-to-code.md: Added a note that thestorybookscript is not yet infrontend/package.jsonbut stories are required by convention regardless, to prevent agents from skipping story creation because the script is absent.docs/agent-workflows/manual-qa-checklist-generator.md: Replaced the generic "feature flags, environments, or auth modes" language in section 4 with explicitperQuestion/endOfInterviewmode checks and full scorecard component path verification, so generated QA checklists always cover both feedback pipeline paths.docs/agent-workflows/pre-merge-full-review.md: Updated Phase 4 deterministic floor frompnpm testto Storybook story coverage check; updated Phase 5 trigger fromfeatureFlag/featureGatepatterns toNEXT_PUBLIC_*behavioral gating; replacedpnpm test --findRelatedTestsin the edit protocol withpnpm typecheckandpnpm lint; replaced the DB query invariant example with a FastAPI response shape example.docs/agent-workflows/test-suite-quality-review.md: Hardened the "no test runner" note to a definitive statement at the top, removed the E2E test review section, renamed "Breakdown by test type" to "Breakdown by coverage type," and established Storybook stories as the primary coverage mechanism to stop agents from searching for test infrastructure that does not exist.