docs(architecture): audit Model access slice under #3522 - #4711
Open
bytelazy wants to merge 1 commit into
Open
Conversation
Audit the two Model access documents against current main: - openai-responses-incremental-transport.md: verified accurate as written. Every cited symbol (ModelAdapter, endLane, previous_response_id, prompt_cache_key, the sdk.response.messages contrast) still exists with the semantics the document describes. No change. - model-metadata-firstscreen-optimization.md: the optimization it proposes has been implemented. The renderer startup path no longer statically imports model-metadata, OnboardingHero no longer imports RECOMMENDED_PROVIDER_TYPES at runtime, and PROVIDER_REGISTRY is now reached only from lazy Settings paths — matching the document's desired outcome. Move the document to docs/archive/ with an Archived banner so it is read as the historical design record rather than an open proposal. Refs apache#3522 Generated-by: Claude (Claude Code)
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
Audits the Model access subsystem slice under #3522 — the two documents listed there were read against current
mainand either corrected or confirmed accurate.docs/architecture/openai-responses-incremental-transport.md— verified accurate, no change. Every cited symbol (ModelAdapter,endLane,previous_response_id,prompt_cache_key, thesdk.response.messagescontrast) still exists with the semantics the document describes.docs/model-metadata-firstscreen-optimization.md— the optimization it proposes has been implemented. The renderer startup path no longer statically importsmodel-metadata;OnboardingHerono longer importsRECOMMENDED_PROVIDER_TYPESat runtime;PROVIDER_REGISTRYis now reached only from lazy Settings paths — matching the document's desired outcome. The document was being read as an open proposal when its acceptance criteria are met, so it is moved todocs/archive/with anArchived:banner so it is read as the historical design record.The move is a git rename (history preserved); the only content change is the two-line banner.
docs/archive/**is out of scope for #3522's audit, but moving a now-implemented proposal into the archive is the audit conclusion for this document, not an edit to an existing archive entry.Refs #3522
Verification
model-metadata-firstscreen-optimizationby path, so the move breaks no links (checkedscripts/,.github/, all*.md/*.ts/*.mjs).node --test scripts/source-legal-inventory.test.mjs(the test that readsdocs/): 5/5 pass.grepagainstpackages/runtime/src.R), so blame/history is preserved.Not run: the repo's full lint/typecheck (a full
npm cidoes not complete from this network). The change is docs-only and confined todocs/; no code or test is touched.AI use
Tool(s) and scope: Claude Code — audited both documents against current code, implemented the archive move and banner, and authored the commit. The commit carries a
Generated-by: Claude (Claude Code)trailer.Checklist
(Both unchecked: this is a docs-only change with no test surface; the relevant
source-legal-inventorytest passes as noted under Verification.)Does this PR entail a change in behavior?