Repository navigation
docs: redraw the README architecture diagram as build, install, run - #119
Merged
Merged
Conversation
The old box listed bin/ and templates/ files without showing how they connect. The new diagram traces the generator step, the install path, each skill run (preamble, Consensus gate, manifest-merge write path, exports folder, timeline and learnings with global promotion), and the Chrome extension as a separate runtime. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ubuntu-latest now resolves to Ubuntu 26.04, and setup-python publishes no 3.9 build for it (3.9.25 ships for 22.04 and 24.04 only), so the 3.9 test leg and the mutation job failed at setup before running any test. The 3.12 leg stays on ubuntu-latest. Co-Authored-By: Claude Opus 5.5 <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.
Summary
The architecture diagram in the README listed the
bin/andtemplates/files without showing how they connect. This replaces it with an ASCII diagram in four parts:bin/idstack-gen-skillsgenerates eachSKILL.mdfrom its template, the preamble, the manifest schema and the resolve snippet../setupregisters the plugin, andbin/idstack-doctorchecks the install.idstack-manifest-merge, withneeds-analysisandcourse-importas the documented exceptionexports/<course-slug>/folder~/.idstack/global/Only the fenced block under
## Architecturechanges. The diagram says "Google AI API" rather than naming the model, so the retired-CLI grep in smoke-test stays clean without needing an exemption tag.Test plan
python3 test/check-doc-accuracy.py .passes./test/smoke-test.sh: the README adds no failures. The only local failures come from an untrackedAGENTS.mdthat is not part of this PR🤖 Generated with Claude Code