docs: align the README and package metadata with the roadmap-first product - #97
Merged
Derssa merged 2 commits intoSep 4, 2026
Merged
Conversation
Derssa
approved these changes
Sep 4, 2026
Derssa
pushed a commit
that referenced
this pull request
Sep 4, 2026
…-aside roadmap (#96) * chore: ignore the local .claude directory * fix(ui): render modals in a portal and lay out the completion screen in two columns * fix(network): do not repeat an unchanged audit toast on config saves * docs: add the demo recording and its reproducible tooling * feat(learning): recalibrate cache-aside to nine steps and 45 minutes * docs: align the README and package metadata with the roadmap-first product (#97) * docs: align the README and contributor docs with the roadmap-first product * chore: refresh the npm package description, keywords and homepage
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
2 participants
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 of Changes
README and contributor-docs refresh, so the first screen a visitor sees describes the product as it is today: guided, auto-graded roadmaps on real containers. Stacked on #96, which adds the GIF file.
CONTRIBUTING.md: roadmap authoring listed first, with the in-app import as the way to test a file; Docker Engine or Desktop instead of Desktop only.SECURITY.md: the supported-versions table still said1.0.x; replaced by "latest npm release andmain".package.json: description, keywords and homepage aligned with the README.No functional change.
Types of Changes
Verification & Testing
Automated Checks
npm run lintsuccessfully with no errors (unchanged from feat: demo recording, completion screen fixes and the nine-step cache-aside roadmap #96; no source file touched)npm run buildsuccessfully with no compilation errors (unchanged from feat: demo recording, completion screen fixes and the nine-step cache-aside roadmap #96)npm testsuccessfully (unchanged from feat: demo recording, completion screen fixes and the nine-step cache-aside roadmap #96: backend 481, frontend 367)Manual Verification
docs/roadmap-format.md,docs/local-roadmaps.md,docs/learning-api.md,docs/adding-a-node.md,docs/media/torollo-demo.gif,CONTRIBUTING.md).package.jsonstill parses;homepageadded,filesuntouched.Checklist