Repository navigation
Give each repeated idea one home - #9
Merged
Merged
Conversation
The daemon/key rule was written into six places when it was fixed. It is the right rule, but it was stated in full every time. chat-agent/README.md keeps the full explanation and becomes the canonical home. It has to stay self-contained regardless: `pixeltable-new` extracts that directory verbatim into every scaffolded project, so a reader may never see the root README. It is also the best of the six -- the only one that says why re-running `service update` does not help, and the only one naming `pxt config --section anthropic` as the diagnostic. The other five keep their warning and every actionable command, and lose the repeated mechanism: root README, .env.example, chat-agent/app.py's docstring, and the dev container's printed steps. AGENTS.md was already one line. Two more repeats: `pxt db update packs the hosted image and workers` was verbatim in four files and now lives once, in AGENTS.md next to the rest of the Cloud sequence. `Advertised order is schema, then service, then insert.` sat directly above a code block showing that order in both app READMEs. Moved the `pxt schema diff` exit codes out of the root README's "For agents" blurb into AGENTS.md, which is meant to be the fuller reference and did not have them. The README keeps a pointer. Docs 409 -> 346 lines, no rule lost. Co-Authored-By: Claude Opus 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.
The daemon/key fix was written into six places. It is the right rule, but it was stated in full every time. Docs go 409 → 346 lines with no rule lost.
One canonical home for the ordering rule
chat-agent/README.mdkeeps the full explanation. That choice is forced as much as chosen:pixeltable-new'sextract_patterncopies that directory verbatim into every scaffolded project, so a scaffolded user may never see the root README — the file has to stand alone. It also happens to be the best of the six versions: the only one that says why re-runningpxt service updatedoes not help ("the plan is already in agreement, so nothing respawns"), and the only one namingpxt config --section anthropicas the diagnostic.The other five keep their warning and every actionable command, and lose only the repeated mechanism:
README.md.env.exampleconfig.tomlalternative, both unique to itchat-agent/app.py.devcontainer/post-create.shAGENTS.mdTwo more verbatim repeats
pxt db update packs the hosted image and workers; it is not Experiment.appeared identically in four files. It now lives once, inAGENTS.md, beside the rest of the Cloud sequence.Advertised order is schema, then service, then insert.sat directly above a code block showing exactly that order, in both app READMEs.One thing moved rather than cut
The
pxt schema diffexit-code contract (0 in sync, 2 pending, 1 error) existed only in the root README's "For agents" blurb, not inAGENTS.md— the file that is supposed to be the fuller agent reference. Moved it there and left a pointer. This is the only change here that grows a file.Verified
ruff check, 49 tests, 1 skipped. Three existing tests constrain this rewrite and all still pass:test_cloud_teaches_hosted_service_updaterequires the literalpxt service update app.py pxt://in bothREADME.mdandAGENTS.md, so the Cloud sections could not simply collapse into one.test_no_em_dashesbans U+2014 in contract markdown — every rewrite uses--.test_one_apply_pathscans the app dirs and the three root.mdfiles for banned apply tokens.Note this repo has no release gate:
pixeltable-newfetchesrefs/heads/main, so merging shipschat-agent/README.mdto every new scaffold immediately.🤖 Generated with Claude Code