Repository navigation
docs: replace stale counts and dead script references with current truth - #408
Merged
Merged
Conversation
An audit found documentation and manifest comments that describe a tree that no longer exists. This corrects them against the tree on 2026-09-03. - README: `dev up` no longer brings up a walkable seam; the region tier went out on 2026-08-08. "Can I use my existing client?" now answers the question, and the architecture paragraph moves under the architecture heading. - schema.md and architecture.md: recount tables (238, not 176), state that no `#[client_visibility_filter]` is declared any more (commit 7fda35a deleted all sixteen with the per-player connections they applied to), and list all 23 scheduled tables instead of 12. Counts that drift now carry the command that reproduces them. - `scripts/publish-module.sh` is not in this repository and never was. The three docs that claimed it calls `debug_repair_after_publish` now say what is true: the operator calls that reducer by hand on every shard after every publish, tracked as lyracore-cli issue 41. - architecture.md section 8 no longer contradicts danger-zones.md section 3 about what a production deploy publishes. danger-zones.md is authoritative. - architecture.md section 9 gains a verification write-up index, so the ten live-check documents are reachable. - Manifest comments no longer cite an `msrv-consistency` CI job, `scripts/preflight.sh`, `scripts/wire-harness.sh`, `adapters/lyracore/run-suite.sh`, `deny.toml` or `.cargo/mutants.toml`. None exists. The MSRV and workspace-member essays shrink to the facts. - CHANGELOG: drop the Keep a Changelog claim. One entry against 163 merges is not a running log; the merged pull requests are the honest history. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
Several documents and manifest comments describe a tree that no longer exists. A reader following them is told the local realm has a walkable seam between two databases, that the module declares sixteen row-level-security filters, and that a script named
scripts/publish-module.shre-arms the schedules after every publish. None of that is true today. The counts are off by a third or more, and the script has never been in this repository.This corrects them against the tree on 2026-09-03. Where a number will drift again, the document now carries the command that reproduces it instead of the number alone.
What changed
README.
dev upbrings up the four-database fixture; the region tier and its seam went out on 2026-08-08. "Can I use my existing client?" now answers the question with a yes, and the architecture paragraph that used to sit under it moves under the architecture heading.schema.md and architecture.md. 238 tables, not 176. 23 scheduled tables, not 12. 122 public and 116 private. No
#[client_visibility_filter]at all: commit7fda35a(2026-08-11) deleted all sixteen in the same change that deleted per-player client connections, which were the only thing an RLS filter ever applied to. The scheduled-table list is complete again, with cadence and location for each. Both status banners now read 2026-09-03. No table in this tree comes from a package.debug_repair_after_publish.docs/danger-zones.md,docs/schema.mdanddocs/aura-stacking-probes.mdeach said a script calls it after every publish. The script is maintainer-local and not tracked here. All three now say the truth: the operator calls the reducer by hand on every shard after every publish, and skipping it presents as a mid-session hang rather than an error. Folding it intolyracore publishis issue 41 in thelyracore-clirepository.One contradiction removed.
architecture.mdsection 8 said a production build must be a plain build.docs/danger-zones.mdsection 3, which is authoritative, publishes with--features=debug_reducersand runs the debug gateway binary. Section 8 now defers to danger-zones and names the posture instead of arguing with it.A document index for the verification write-ups. Ten live-check documents were unreachable from any other page.
architecture.mdsection 9 now lists them under one heading, pluspackage-api.md. No file moved or was renamed.Manifest comments.
Cargo.toml,gateway/Cargo.toml,module/Cargo.toml,rust-toolchain.toml,.gitignoreand.wire-harness-revcited anmsrv-consistencyCI job,scripts/preflight.sh,scripts/wire-harness.sh,adapters/lyracore/run-suite.sh,deny.tomland a checked-in.cargo/mutants.toml. None exists. Each comment now states current truth in one or two lines. The MSRV comment shrinks from a twenty-line history to the two facts that set the floor: everyspacetimedb-*crate declaresrust-version = "1.93.0"andedition = "2024", so the real MSRV equals the pinned toolchain.CHANGELOG. One Unreleased entry stands against roughly 163 merges, so the Keep a Changelog claim was not true. The header now points at the merged pull requests as the running history and keeps this file for release-level meaning. Nothing was backfilled.
Not changed
module/src/publish_safety.rsandmodule/src/test_scan.rsstill namescripts/publish-module.sh, and both already treat it as optional and absent. Source is out of scope for this change.Documentation only. No Rust or TypeScript source touched.
Written by Claude Opus 5 through Claude Code.
Review fixes by GPT-5.6 through the Codex harness in T3 Code.