Shorten and reorganize the docs; facts live in decisions #151
No reviewers
Labels
No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
No milestone
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
ethan-hann/SavePoint!151
Loading…
Reference in a new issue
No description provided.
Delete branch "docs-readability"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
The guides were wordy, repeated ideas and explained the obvious. Each guide now says what its reader needs to act, once; rationale, history and measurements live in docs/decisions.md and the guides cite them (Dn).
User guide: reorganized around the player's path (set up a game, first snapshot, play, go back, profiles, Activity, Free up space, Settings, when something goes wrong); prose about 18% shorter. README: orients without repeating the user guide, about 18% shorter. Developer guide: tests, gates, rules and languages before packaging; about 24% shorter. Architecture: contracts and where code lives, with decision references; 28% shorter. UI guide, testing guide, dogfood checklist and AGENTS.md: tightened, every rule and checklist item kept.
decisions.md: every fact the guides gave up was folded into the decision it belongs to (the docs server setup is now D55's record), and the log was tightened; every Dn heading and item number is unchanged. The docs site builds with warnings as errors and the screenshot coverage tests pass.