Skip to content

Doc cleanup: archive done follow-ups, add CHANGELOG, refresh status lines - #80

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

@guijacquemet guijacquemet commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Applies the 2026-11-07 doc audit of this repository (approved by the owner). Docs only.

Class Count Changes
ARCHIVE 2 docs/followup_preprocessing.md and docs/followup_cellpatcher.md moved to docs/archive/ with a "Historical record, not current" note; inbound links fixed in README, AGENTS, docs/plan.md, docs/contract.md. The P-number references in the plan still resolve (the files exist, in the archive).
UPDATE 4 README.md: Status section trimmed to what the library offers plus the first API example; the rest moved verbatim to the new CHANGELOG.md, and the Documents table lists the changelog. CHANGELOG.md (new) holds those release and migration notes and an Unreleased entry for the post-v0.3.4 refusals (#72 to #79), written from the commit history. docs/plan.md Status line. docs/contract.md: Milestone 5 row marked done. AGENTS.md: Milestone-1 instruction replaced by a bit-identical-outputs rule, "v0.3.3 debt" wording made neutral, docs table updated.
DELETE / MERGE 0 none in the report

Not done or rejected:

  • docs/plan.md §10 release log moved to CHANGELOG: not done. The release bullets are interleaved with the milestone list that the contract's table refers to, and the release notes already exist in the README text now in the changelog. Left in place.
  • docs/contract.md §1 historical narrative trim and adding the new refusals to §9: not done. That is a rewrite of contract text; contract docs are not to be reworded here. No owner decision N61+ exists for the refusals, so the Unreleased entry only lists them.
  • The audit's line numbers for the README were stale (v0.3.4 section was at :171, not :112); I worked from the content.
  • The Unreleased entry lists refusals by PR title, not by re-verifying each message against code.

Checks:

  • python tools/check.py: 713 passed, 2 skipped (tests/test_rgb.py:80, csbdeep not installed); code rules and ruff check passed.
  • Relative-link check over all tracked *.md: no broken links.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Scma6W3LC11s3qjXHZuGDm

@guijacquemet
guijacquemet merged commit d4087ac into main Nov 7, 2026
8 checks passed
@guijacquemet
guijacquemet deleted the claude/doc-cleanup branch November 7, 2026 08:28
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