Skip to content

Doc cleanup from the 2026-11-07 audit - #38

Merged
guijacquemet merged 1 commit into
mainfrom
claude/doc-cleanup
Nov 7, 2026
Merged

guijacquemet merged 1 commit into
mainfrom
claude/doc-cleanup

Conversation

@guijacquemet

Copy link
Copy Markdown
Collaborator

Applies the owner-approved LabConstrictor doc audit (against 1a12399). Docs only. Nothing under .template_sync/, tests/fixtures/ or .tools/ is touched.

Class Count Files
UPDATE 1 README.md:60: placeholder YOUR_USERNAME issues link now points to CellMigrationLab/LabConstrictor/issues
DELETE 2 notebooks/README.md and src/README.md (both empty)
KEEP all others per the report

Claims not applied as written:

  • The two empty READMEs were renamed to .gitkeep instead of being removed outright. They are the only tracked files in notebooks/ and src/, and the workflows update_on_notebook_change.yml and update_on_src_change.yaml watch those folders. Nothing references the README names.
  • .tools/docs/use_cases.md was not changed: the report itself could not verify that listing only VLab4Mic is wrong (it may be intentional), and this file ships to every generated app. Needs an owner decision: link to the App Centre instead, or add the other apps.

PR template checklist:

  • Changes a button label, form field, workflow or artifact name, installer name or file path: no (no .tools/docs page names the removed READMEs)
  • Bumped template_version if users must act: not needed
  • Screenshots still valid: unaffected

Checks:

  • python -m pytest tests -q (pytest, pyyaml, jsonschema in a venv): 204 passed, 246 subtests passed.
  • Link check over tracked *.md: no new broken links; the only broken relative links are the known ones in .template_sync/resources/**, tests/fixtures/** and .tools/templates/download_executable_template.md (not actionable, per the audit).
  • ruff and mypy were not run (no code changed).

Generated by Claude Code

@guijacquemet
guijacquemet merged commit ac8f7d5 into main Nov 7, 2026
4 checks passed
@IvanHCenalmor
IvanHCenalmor deleted the claude/doc-cleanup branch November 12, 2026 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants