docs: legibility note β limitations verified from the tree, nothing existing modified - #5
Merged
Merged
Conversation
β¦xisting modified
Owner
Author
|
Merging as part of the wave-66 PR sweep. Verified before merge:
|
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.
What this is
A read-only legibility pass. No existing file is modified β this PR only adds
LEGIBILITY.md, and it is trivially deletable. Close it and nothing else changes.Why
A census of 100 fleet repos (
SuperInstance/quilt-research-canons/projects/fleet-legend/)graded every repo against five obligations. This one already passes entry (L1, L2); it
fails the two that only cost something once a reader is already inside:
What is in here, and where each line came from
5 finding(s), each read out of the repository and each carrying its evidence. Nothing
is inferred from the README, because the README is the thing being fixed.
.github/workflows/ci-python.yml), but which events it runs on and what it actually executes are decided inside that file, not here.github/workflows/ci-python.ymlexists in the treetests/test_config_wizard.py); what runs them is not recorded anywhere in the treetests/test_config_wizard.pyand 3 other path(s) match the test patternLICENSE)LICENSEstandalone/chat.py: files = ["IDENTITY.md", "SOUL.md", "AGENTS.md", "USER.md", "TODO.md",;standalone/start.py: The agent reads NEXT-ACTION.md, does the task, updates TODO.md, commits.;standalone/onboard.py: TODO.md β what to dotests/test_git_agent.py:156;tests/test_github_fleet.py:148). Nothing in the repository treats them as a set, so a reader who hits one has to grep for itWhat we deliberately did NOT write
A completer that invents a receipt or a failure mode produces a confident lie, and a
confident lie is worse than a blank space, because a reader cannot tell it from a real
limitation. Where a fact was not derivable, this file says so instead of filling the gap.
If you want to accept part of this
Take the table and ignore the rest. Every row is a predicate over the file listing or over
named source lines, so disagreeing with a row costs you one
lsor onegrepβ say so ina review comment and the line gets corrected or dropped.
Reviewed with tooling from
SuperInstance/quilt-research-canons/projects/fleet-legend/.