docs: complete wiki/core workspace coverage, llms.txt audit + --check-citations mode#41
Merged
Merged
Conversation
…ions for release Coverage (new sections): LOS-halo simulation machinery (LOSSampler, negative-kappa sheets), sky background via DatasetModel, point-source deblending, custom Analysis subclasses, double-Einstein-ring multi-plane pointer; weak-lensing page rewritten for the shipped FitWeak/AnalysisWeak API (reduced shear, A2744 real-data capstone, strong+weak joint series). Staleness (release audit): removed-Plane-class prose fixed (galaxy_and_plane, tracer, stack pages -> Galaxies); sampler module->package citation moves (nautilus/, dynesty/, emcee/, ...); over_sampling, sensitivity, mass/abstract, basis, csv-api, priors/visualize config layouts re-grounded against installed source; slam_pipeline fictional import replaced with the inline-functions reality; index.md gains missing operations/external entries; llms.txt reference bullets point at the wiki indexes. Validated: audit_skill_apis.py 0 missing/broken (117 symbols); provenance re-stamped (analysis_objects); all Project:path citations + relative links resolve. Issue: #40 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…st checkouts The release audit found ~30 stale `Project:path` citations on a tree the symbol audit scored 0-broken: symbols and citation paths are independent failure axes. New mode scans skills/, wiki/core/, AGENTS.md and llms.txt (inline cites, projects from sources.yaml, plus wiki frontmatter sources[].paths[]) and resolves each path against a checkout (installed -> sources/ -> sibling); `...` abbreviations only need their concrete prefix. Missing path = ERROR (exit 1); unresolvable project tree = warning. First run caught 5 more live ones (README.rst -> README.md in the stack pages) — fixed here. Documented as al_audit_skill_apis §6; added to al_refresh_api_docs "complete" criteria. Issue: #40 Co-Authored-By: Claude Fable 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.
Summary
Release-readiness pass over the assistant's documentation layer (issue #40): completes the
wiki/corecoverage of theautolens_workspacesurface, purges a removed-API documentation class, auditsllms.txt, and adds the--check-citationsaudit mode that makes the discovered staleness class mechanically checkable.Scripts Changed
Docs-first change; the one code file is the audit tool:
autoassistant/audit_skill_apis.py— new--check-citationsmode: resolves every`Project:path`citation (inline + wiki frontmattersources[].paths[]) against a checkout of the cited project (installed →sources/→ sibling);...abbreviations need only their concrete prefix; exit 1 on missing paths.wiki/core/concepts/*— new coverage: LOS-halo machinery (LOSSampler, negative-kappa sheets) insubstructure_and_subhalos; sky background viaDatasetModelinextra_galaxies_and_noise_scaling; deblending inpoint_source; double-Einstein-ring pointer intracer;weak_lensingrewritten for the shippedFitWeak/AnalysisWeakAPI (reduced shear, A2744 capstone, strong+weak series).wiki/core/api/analysis_objects.md— new "CustomAnalysissubclasses" section (companion for theal_custom_analysisstub); provenance re-stamped.Plane-class prose fixed acrossgalaxy_and_plane,tracer,stack/{autogalaxy,autolens},cosmology_and_units(tracer.planesreturnsGalaxiesnow).Project:pathcitations re-grounded against installed source: sampler module→package moves,over_sampling/,grid/sensitivity/,mass/abstract/,profiles/basis.py, CSV API →autogalaxy/galaxy/galaxy_model_csv.py, priors/visualize config layouts,slam_pipeline's fictional import,README.rst→README.md.wiki/core/index.md— missingoperations/dataset,hpc_infrastructure, External entries; hooks refreshed.llms.txt— reference bullets point at the two wiki indexes; rest audited good.skills/al_audit_skill_apis.md§6 +al_refresh_api_docs.md— document the new mode and add it to the refresh "complete" criteria.Validation checklist
audit_skill_apis.py(symbol audit): 0 missing/broken across 55 files, 117 symbolsaudit_skill_apis.py --check-citations: 90 files, 391 citations, 0 missing pathsaudit_skill_apis.py --check-provenance: 0 errors (97 pre-existingmain-pin warnings)Test Plan
python autoassistant/audit_skill_apis.py --check-citationson main stays 0Closes #40.
🤖 Generated with Claude Code