Repository navigation
Remove internal notes and tidy the public docs - #165
Merged
Merged
Conversation
It opened with about 100 lines of past-release history (commit IDs, run numbers, timestamps and who approved each one) and narrated decisions throughout. That history is on GitHub Releases and in the changelog. The page now states the process: branches, versioning, hotfixes, the pre-release checks, how a minor and a patch ship, private candidates, the checklist, issue handling, the yearly review and changelog rules.
The repository carried about 1,850 internal files that were never meant for readers: design concepts and test evidence (docs/design), audit notes (docs/audits), per-version release records, version-specific implementation notes, AI image prompts and social post drafts in docs/media, and a commit hook written for agent machines. They remain in Git history. The public docs also narrated who decided what and when. ARCHITECTURE.md, THIRD_PARTY.md (and the in-app CREDITS.txt copy), CONTRIBUTING.md, SECURITY.md and the tool and fixture READMEs now state the rules and credits plainly, without dated decision notes, private Linear ticket numbers or links to the removed notes. Supporting changes: - The docs-only CI fast path now covers guide pages instead of docs/design. - biome.json, .gitattributes and one workflow trigger drop paths that no longer exist. - .gitignore no longer lists local assistant files. - Code comments drop ticket numbers and links to removed notes.
Never ship a beta UnRAR, Binds' key names, how Launch restarts Steam, keeping unit tests away from the real Steam install, and the Vitest clock caveat. They were only recorded in local notes.
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
1 participant
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.
What and why
The public repository carried about 1,850 files that were internal working material rather than anything a player or contributor needs:
docs/design/(1,577 files, 68 MB): design concepts, screenshots and archived test evidencedocs/audits/(251 files): audit notesdocs/release-*.mdand ten version-specific implementation notesdocs/media/release-*: announcement drafts, including two image-generation prompts.githooks/: a commit hook written for agent machinesThey stay in Git history; nothing is rewritten.
The docs that remain also narrated who decided what and when, and pointed at internal notes. Those passages now state the rule or credit plainly:
docs/RELEASE.mdis rewritten as a release guide: branches, versioning, hotfixes, pre-release checks, shipping a minor or patch, private candidates, the checklist, issue handling and changelog rules. The release history at its top is already on GitHub Releases and in the changelog.docs/ARCHITECTURE.md,THIRD_PARTY.md(and its in-app copyCREDITS.txt),CONTRIBUTING.md,SECURITY.md,scripts/fixtures/README.md,tools/inventory-probe/README.mdandtools/promo/README.md.Supporting changes
docs/guide/instead ofdocs/design/, with its tests updated.biome.json,.gitattributesand the Windows package workflow's path trigger drop paths that no longer exist..gitignoreno longer lists local assistant files.SECURITY.mdno longer says SmartScreen warns only on first run; it can warn on each new version.Checks
biome check .cargo fmt --checkfor the app and the inventory probenode --test scripts/ci-docs-only.test.mjs scripts/release-guards.test.mjs(18 pass, including the credits/THIRD_PARTY match)