docs: reconcile README, DEPLOYMENT, CONTRIBUTING and CLAUDE.md with the tree (gh-#774) - #784
Merged
Merged
Conversation
…he tree (gh-#774) README: the continuity and truth-gate claims now say what the engine and CopyClaims deliver (safe rotation needs api + db; mksafe's final guard is logged silence; a 7s gap between safe tracks; the gate checks numbers, weekdays, weather words and clock words literally, passes when uncertain, re-asks once, floors or drops by kind). build.sh no longer preflights .env (v5.8.3). Layout gains GenWave.Ads, GenWave.Plugins, the scripts, the overlays and tests/; migration range de-versioned. v5.7.0 voice/jingle packs and v5.8.0 sponsors paragraph. Test section: PR tier needs ffmpeg, Host suite parallelism cap, admin-ui chain matches ci.yml (lint + link-order guard), the full suite is a maintainer gate not a merge requirement. NuGet version tracks the tag. Shipped-phases paragraph made version-agnostic. DEPLOYMENT: the verified-appliance ss listing no longer claims :3000 while the checklist clears COMPOSE_PROFILES; home-piper-only row lists the four disabled services; the file actions example says compose.local.yaml is operator-authored. CLAUDE.md: 9 test projects, Ads/Plugins in both trees, commands match reality (build.sh runs tests; raw compose up skips migrations), docs/ noted as gitignored. CONTRIBUTING: same test-command truths.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #774.
/document pass on 2026-09-15: docs diffed against the tree at v5.8.3, not against each other.
README
GW_SAFE_GAP_SECONDSgap is named.build.shno longer preflights.env(v5.8.3);git cloneline added above./setup.sh.GenWave.Ads,GenWave.Plugins, scripts, overlays,tests/; migration range de-versioned.-- xUnit.MaxParallelThreads=3; admin-ui chain matchesci.yml(npm run lint, link-order guard); the full suite is a maintainer pre-release gate, not a merge requirement.DEPLOYMENT
sslisting claimed127.0.0.1:3000while the same checklist clearsCOMPOSE_PROFILES(admin_ui is profileadmin).home-piper-onlyrow lists all four disabled services (kokoro, voice-seed, ollama, ollama-init).compose.local.yamlin the file-actions example is labelled operator-authored.CLAUDE.md / CONTRIBUTING
build.shruns tests; rawdocker compose upskips migrations;docs/is gitignored.tools/check-doc-drift.shgreen; the 73 doc-pinning Host facts (Story107/174/344/431/436) pass.