Skip to content

docs: complete wiki/core workspace coverage + llms.txt release audit #40

Description

@Jammy2211

Overview

autolens_assistant is heading to its first full public release. During development its documentation layer was deliberately kept partial. This task makes the wiki part of the layer that maps to autolens_workspace fully complete, and audits llms.txt — the front door that ChatGPT/Claude and other agents read — so it is release-ready. The 14 stub skills (Status: stub, honestly labeled in skills/README.md) are out of scope here: this task completes the wiki, not the skill recipes (see the scope question below).

Plan

  • Audit wiki/core/ against the full autolens_workspace surface (llms-full.txt + scripts/ tree) and post a coverage table (covered / shallow / missing / stale) as a milestone comment.
  • Write the missing wiki pages — confirmed candidates from the "catalogued, not yet stubbed" queue with real workspace scripts: over-sampling, multi-plane lensing, line-of-sight halos; plus whatever the audit surfaces (workflow outputs, Bayesian model comparison, shapelets/operated-profile/sky-background coverage — some may fold into existing pages).
  • Refresh stale pages: every page is last_updated: 2026-05-22, predating the July weak-lensing rework (FitWeak) and the functional plot API — concepts/weak_lensing.md and api/plotting.md are known suspects.
  • Verify each stub skill's companion wiki page is genuinely complete, and update wiki/core/index.md + wiki/core/external/skill_citation_map.md for any new pages.
  • Audit llms.txt: every link resolves, routing and framing match the mature release state, hand-off to the workspace catalogue (autolens_workspace/llms.txt / llms-full.txt) is correct.
  • Validate with autoassistant/audit_skill_apis.py (zero stale PyAuto* symbols) and ship via ship_workspace — run ends at PR-open per the autonomy contract.

Scope question (supervised checkpoint): the 14 stub skill recipes stay stubs for this release — the wiki is completed, the skills index labels stubs honestly, and recipe-filling is queued as follow-up prompts issued one at a time. Reply here if you want stub recipes pulled into release scope instead.

Detailed implementation plan

Affected Repositories

  • autolens_assistant (primary, only repo)

Work Classification

Workspace (docs; develops in-place — no worktree, per repo precedent)

Branch Survey

Repository Current Branch Dirty?
./autolens_assistant main clean (1 untracked personal file james.bib — never commit; repo is a public template)

Suggested branch: feature/assistant-wiki-release

Worktree root: none — autolens_assistant develops in-place on a feature branch.

Implementation Steps

  1. Coverage audit (read-only). Build the area map from autolens_workspace: llms-full.txt, workspace_index.json, and the scripts/ tree — imaging (features: extra_galaxies, linear_light_profiles, multi_gaussian_expansion, no_lens_light, pixelization, scaling_relation; advanced: double_einstein_ring, los_halos, mass_stellar_dark, operated_light_profile, shapelets, sky_background, subhalo), interferometer (+features/datacube), point_source, group, cluster, multi, weak, guides (advanced: multi_plane, over_sampling, over_sampling_chaining, custom_analysis, add_a_profile; results; plot; profiles; units; modeling). For each area, locate its wiki/core/ page(s) and classify: covered / shallow / missing / stale (frontmatter pinned_commit + last_updated vs current source). Post the table to this issue.
  2. Write missing pages under wiki/core/concepts/ (or api/ where the content is API-shaped), following the existing page schema (frontmatter: title, sources with pinned_commit, last_updated). Judgment call per area: dedicated page vs a section in an existing page (e.g. shapelets → concepts/light_profiles.md). wiki/core/ is read-only except via the al_update_wiki maintainer workflow — this task is that workflow; follow skills/al_update_wiki.md.
  3. Refresh stale pages. Known suspects: wiki/core/concepts/weak_lensing.md (July rework: FitWeak, NumPy-only, loaders default is_reduced=True) and wiki/core/api/plotting.md (functional aplt.* API; no MatPlot2D/Output objects). Re-pin sources: commits; bump last_updated.
  4. Cross-layer consistency. For every new page: add to wiki/core/index.md; check wiki/core/external/skill_citation_map.md rows still resolve; confirm each stub skill's companion wiki page is complete enough to answer "what/why" questions the stub can't.
  5. llms.txt audit (autolens_assistant/llms.txt): verify all relative links (AGENTS.md, skills/README.md, wiki/) and external URLs (workspace llms.txt, HowToLens) resolve; the paste-friendly opening prompt stays; claims match post-audit reality. Cross-check wiki/core/external/workspace.md still matches what the workspace ships at its root.
  6. Validate. python autoassistant/audit_skill_apis.py full audit — zero stale symbols across skills/ and wiki/core/api+stack/ (regenerate api_audit_baseline.json if the audit workflow requires); link-check edited pages.
  7. Ship via ship_workspace: commit on feature/assistant-wiki-release, PR to PyAutoLabs/autolens_assistant, four-leg gate (tests: n/a — no test dir, stated in PR body; smoke: n/a — doc-only change, stated; review faculty: CLEAN required; Heart: GREEN/STALE required, no launch-time YELLOW ack was given). Run ends at PR-open; merge is human.

Key Files

  • wiki/core/index.md — wiki table of contents; every new page registers here
  • wiki/core/concepts/*.md, wiki/core/api/*.md — the pages being completed/refreshed
  • wiki/core/external/{workspace.md,skill_citation_map.md} — the workspace mapping layer
  • llms.txt — the agent-facing front door under audit
  • skills/README.md — stub labeling stays truthful if anything changes
  • autoassistant/audit_skill_apis.py, api_audit_baseline.json — validation gate
  • autolens_workspace/{llms.txt,llms-full.txt,workspace_index.json} — read-only source of the coverage map

Prose tier

Wiki pages are science-teaching prose → judgment tier (Fable/Opus), per the tutorial-prose split in PyAutoBrain/skills/WORKFLOW.md. Mechanical ship steps delegate to the execution tier.

Original Prompt

Click to expand starting prompt

the autolens_assistant was improved and made mature by Fable, but I think its skill layer which maps to autolens_workspace is incomplete (with the motivation being we were in development so didn't want to put everything in there whilst not mature). We are now doing a full release, so make sure the wiki part of this layer is fully complete. Also, make sure the llms.txt file, which interfaces with ChatGPT and others is also good to go

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions