docs: fix README drift - #37
Merged
Merged
Conversation
The READMEs described a tree that no longer exists. Surfaced by the widened hygiene refs scanner (PyAutoBrain#178, #180); same sweep as autolens_workspace#372 / autogalaxy_workspace#179. config/**/README.md inventories rewritten to list what actually ships: - config/README.md listed `grids` (gone), `non-linear` (it is `non_linear`) and `notation` (now notation.yaml, a file), and omitted output.yaml/build - config/non_linear/ ships only GridSearch.yaml, not mcmc/nest/mle.yaml - config/visualize/ ships general.yaml and plots_search.yaml (plus plots.yaml where present), not include.yaml/mat_wrap*.yaml Navigator catalogue regenerated, since README text feeds llms-full.txt and workspace_index.json. Prerequisite for widening PyAutoHands' check_navigator.py gate: it is repo-agnostic and runs on six repos, so this drift had to clear before the gate could see these shapes without turning these repos red. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The previous commit regenerated with the library project name (autolens / autogalaxy / autofit) rather than the project this repo declares in .github/workflows/navigator_check.yml (howtolens / howtogalaxy / howtofit), which rewrote the catalogue title and failed the staleness check. 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
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.
Part of PyAutoLabs/autofit_workspace#123, which tracks this sweep across the four navigator-gated repos.
Summary
The READMEs described a tree that no longer exists. Surfaced by the widened hygiene
refsscanner (PyAutoBrain#178, #180) — the same sweep already merged as autolens_workspace#372 and autogalaxy_workspace#179.Why now: PyAutoHands'
check_navigator.pyis about to be taught the workspace-README reference shapes so this drift is caught at PR time. That gate is repo-agnostic and runs on six repos, so it could not be widened while these four were still dirty without turning them red. Sweeping first means the gate lands clean everywhere instead of grandfathering drift into.navigator_check_ignore.Scripts Changed
No
.pyscripts changed — documentation only, plus the regenerated navigator catalogue.config/**/README.mdinventories rewritten to list what actually ships:config/README.mdlisted the foldersgrids(does not exist) andnon-linear(it isnon_linear), andnotation(nownotation.yaml, a file), while omittingoutput.yamlandbuild.config/non_linear/ships onlyGridSearch.yaml— notmcmc.yaml/nest.yaml/mle.yaml.config/visualize/shipsgeneral.yamlandplots_search.yaml(plusplots.yamlwhere present) — notinclude.yaml/mat_wrap*.yaml.Navigator catalogue (
llms-full.txt,workspace_index.json) regenerated, since README text feeds it.Validation
hygiene refsreports zero README findings for this repo.python PyAutoHands/autohands/check_navigator.py --root . --banners=fail— PASS.scripts/↔notebooks/README mirrors kept byte-identical.🤖 Generated with Claude Code