Repository navigation
docs(readme): architecture diagram and the sourced how-it-works note - #572
Merged
Merged
Conversation
Under the hood gains the two-doors architecture diagram as a standalone SVG (assets/how-cortex-works.svg, paper-surface values copied from the AI Architect design tokens, its own background so it reads in GitHub's light and dark themes) and a link to the ai-architect.tools note that traces a memory and a decision through the code, every claim linked to v4.22.0. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]> Claude-Session: https://claude.ai/code/session_016CwRqZLmNxZ6LatpmKrKvH
Owner
Author
|
ZETETIC-REVIEW: APPROVE Reviewed on the current head, based on origin/main. The change adds the diagram asset and a link paragraph to Under the hood, and nothing else in the README. The SVG was rendered once in headless Chrome and is legible, and it paints its own background for both GitHub themes. Both linked note URLs are live: fetched on 2026-09-15, with the expected titles. The doc-claim, version-surface and badge gates pass locally. CI is green: 24 passed, 4 skipped. |
Merged
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
This adds the two-doors architecture diagram and a link to the new note at https://ai-architect.tools/notes/how-cortex-remembers (French version at /fr/notes/how-cortex-remembers) to the README's Under the hood section. The note traces a memory and a decision through the code, and every claim links to the lines of the v4.22.0 release.
The diagram is a standalone SVG,
assets/how-cortex-works.svg, generated from the same source as the note's Exhibit 01. Its colours are the paper-surface values from the AI Architect design tokens, and it paints its own background, so it reads in both GitHub themes. Nothing else in the README changes.Verification
check_doc_claims.py: OK. The new text states no count that a claim family could mismatch.check_version_surfaces.py: 17 sites agree.generate_repo_badges.py --check: OK.--base origin/main: OK.pytest tests_py/scripts -k "readme or doc_claim or badge or codex_plugin or version": 324 passed.🤖 Generated with Claude Code
https://claude.ai/code/session_016CwRqZLmNxZ6LatpmKrKvH