Reorganize docs, rewrite changelog and add existing-install guidance - #6
Merged
Merged
Conversation
- Move the seven dated experiment reports to docs/reports/ and fold PLAN.md and PUBLISHING.md into MAINTAINER.md. - Rewrite CHANGELOG.md in Keep a Changelog form with user-facing entries only. - Keep the file inventory in tests/test_publication.py alone and drop the copy in the release review. - Replace sentence assertions in tests with heading, link and token checks. - Add an "Already installed?" README section for the icon and port changes, linked from the configuration reference. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nrm65fBRmGmRBTW3PhyeMm
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
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
This PR applies the six "worth doing" items from the repository review.
Changes
docs/reports/. Links in the living documents point to the new paths. The reports themselves only link to each other, so they are unchanged.docs/PLAN.mdanddocs/PUBLISHING.mdintodocs/MAINTAINER.md. The maintainer guide now has sections for fixed decisions, layout, checks, repository settings, release process and ongoing maintenance.CHANGELOG.mdin Keep a Changelog form with Added, Changed, Fixed and Known limitations. Process notes are gone. Thev0.1.0tag waits until the app is visible in the public catalog.tests/test_publication.py. The release review no longer carries a copy, and the test that compared the two is removed.The two stale test-count lines that remain are inside dated review records in
docs/VALIDATION.mdand describe what passed on those dates.Testing
python3 -m unittest discover -s testspasses all 28 tests.🤖 Generated with Claude Code
https://claude.ai/code/session_01Nrm65fBRmGmRBTW3PhyeMm