[Docs] Update the ARCHITECTURE.md, METHODOLOGY.md, etc. files to reflect current architecture#18
Open
nojibe wants to merge 8 commits into
Open
Conversation
… improve storage architecture section with new data organization insights.
…ault judges, and enhance classification scales with new 10-class experimental mapping.
…le and update storage persistence details for judge agreement in evaluation configurations.
ARCHITECTURE.md and METHODOLOGY.md file to reflect current architectureARCHITECTURE.md, METHODOLOGY.md, etc. files to reflect current architecture
Clarified the description of evaluation paths in the Weval architecture.
- search_index.json → search-index.json (matches SEARCH_INDEX_FILENAME constant in storageService.ts) - Clarify that calculateHybridScore is defined in calculationUtils.ts; summaryCalculationUtils.ts orchestrates it, not defines it Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Cut sentences that repeated adjacent headings or duplicated content already stated in Section 4 (workflow descriptions under diagram subheadings, filler section intros, core.json lazy-loading paragraph). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
callBackgroundFunction awaits a response with a 30s timeout — not truly fire-and-forget. For long evaluations the caller's connection drops but Railway continues running the handler to completion. Replace fire-and-forget language with accurate description throughout. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Description
Realigns
ARCHITECTURE.md,METHODOLOGY.md,BLUEPRINT_FORMAT.md, andINTER_AGREEMENT_PLAN.mdwith the current system. Several diagrams and sections had drifted from the code.Summary
ARCHITECTURE.mdworkshop/,pr-evals/, andndeltas//vibes//compass/underlive/models/, with descriptions.api/internal/background routes (execute-pr-evaluation-background,execute-api-evaluation-background,generate-pairs-background, …)./sandbox-runs/→live/sandbox/runs/, corrects the dispatch edge label —callBackgroundFunctionawaits a response up to a 30s timeout; Railwaycontinues running the handler to completion if that window is exceeded.
METHODOLOGY.md.search_index.json→search-index.json(matchesSEARCH_INDEX_FILENAMEconstant instorageService.ts).calculateHybridScoreis defined incalculationUtils.ts;summaryCalculationUtils.tsorchestrates it, not defines it.core.jsonlazy-loading paragraph that duplicated the Section 4 architectural concept.METHODOLOGY.mdBLUEPRINT_FORMAT.md&INTER_AGREEMENT_PLAN.mduseExperimentalScaledescription from "9-point" to "10-class"; notes thatFORCE_EXPERIMENTAL = truecurrently makes the flag a no-op.qwen/GPT-OSS models → current set); adds cross-family consensus rationale.INTER_AGREEMENT_PLAN.md— storage usesstorageService(S3 in production, local FS in dev).Testing
.github/workflows/, handlers inapp/api/internal/, and S3path constants in
storageService.ts.markdownlintlocally; no remaining violations.