Rewrite README as public-facing intro#8
Merged
Conversation
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 previous README read like a code walkthrough — long bullet lists, internal
APIs, deep sandbox config, milestone tables — before ever telling a new visitor
what the project actually is. This rewrite re-orients it as the public's
introduction to the project.
What's new
docs/install-runtime-workflow.md, which already covers them.docs/,backend/README.md,frontend/README.md, andcurriculum/exercises/README.md, which the README now links to from a single "Going deeper" list.What's preserved
./install.sh,./run.sh, opt-in prompts).File changes
README.md— 594 → 193 lines (-452 / +142). No other files touched.Testing
docs/*,frontend/README.md,backend/README.md,curriculum/exercises/README.md,backend/app/safety.py,backend/app/docs_refs.py,.github/workflows/ci.yml,adr/0001-offline-first-local-llm.md,prompts/tutor-system-prompt.md).🤖 Generated by Computer