docs: close the README's run-locally gaps; port the two commented guide sections (#880) - #987
Merged
Conversation
The README is the canonical run-locally copy (#984); this closes its gaps against the issue's criteria and moves the two subsections that were commented out on the landing page into it: - Paid live workflow now documents the paused boot -> viewer -> setup screen (cast + knobs) -> Start flow, and how to rehearse it for free with --brain mock --start-paused. - 'If something goes wrong' gains the invalid-configuration entry: the setup screen surfaces the server's 400 detail under Start. - 'What's on by default' (unconditional / provider-gated / knobbed faculties + the showcase config) ported from HomeView's commented JSX. - 'Adding your own verb' ported from ImplementationSection's commented JSX, quoting snippets/my_verb.py verbatim; a new pin test keeps the README block byte-identical to the template that test_landing_snippets.py already proves compiles against the engine. The commented JSX blocks, their TODOs, and toc.ts placeholders are deleted — the content's home is the README now, not a future restore. RunLocallySection's closing sentence points at the two new sections instead of a vague 'ships alongside the code package'. Refs #880. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…880) Found by the clean-checkout test this issue requires: the free live workflow boots, but the viewer renders a gray map because the three licensed art packs are deliberately absent from the repository (#876, no-redistribution licenses) and the README never mentioned ASSETS.md. Missing sheets also cascade into a viewer.gd script error, so the symptom is not obviously 'assets'. - Free live workflow opens with the one-time ASSETS.md drop-in step. - 'If something goes wrong' gains the gray-map entry. Refs #880. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This was referenced Aug 5, 2026
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
1 participant
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.
What
The README on
prodis the canonical run-locally copy (#984). This PR closes its gaps against #880's criteria and moves the two landing-page subsections that were commented out "until #884" into it, per the amended scope:--brain mock --start-pausedas the free rehearsal.ASSETS.md. Now it does, up front and in the failure list.HomeView.tsx/ImplementationSection.tsxinto the README; the dead comment blocks, their TODOs, and thetoc.tsplaceholders are deleted. The verb guide quotessnippets/my_verb.pyverbatim and a new pin test intest_landing_snippets.pykeeps it byte-identical to the template the suite already proves compiles against the realActionbase class.RunLocallySection's closing sentence now names the two new README sections instead of "ships alongside the code package".Verified
uv sync --extra server→ mock backend →run.sh scenes/viewer.tscnconnects over/live//events/WebSocket with zero errors once assets are dropped in perASSETS.md;--start-pausedreportsconfigurable, a bad knob 400s with a named detail (plan 'llm' needs the llm brain), and a cast-onlyPOST /config+/resumestarts the day with exactly the chosen cast.Closes #880.
🤖 Generated with Claude Code