Repository navigation
docs: cut the contributor reading path to three documents - #638
Merged
Merged
Conversation
Mathih13
force-pushed
the
docs/contributor-onboarding
branch
from
October 10, 2026 11:57
abcc46d to
34db4ab
Compare
…rom the tree Git history keeps them. The last commit that holds them is b811330 on main. The region fixture test goes with its fixture, and the triage renderer with the triage output. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
One index lists them. Their content is unchanged apart from relative links. The Loot Roll promotion note is a design invariant, so it moves to docs/design. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
.gitignore already excludes .claude/tickets/. The files stay on disk. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The history prune, disk guard, capture wrapper, their units and tests now live in deploy/ of LyraCoreProject/lyracore-cli, which runs their CI job. The Standalone Supervisor unit stays here because the pinned CLI reads it from this path. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ssage each The alliance-eastern terrain check returned early and passed without client data. It is now an ignored test like its sibling. The two near-identical SpacetimeDB ignore messages become one. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
docs/development-cli.md becomes a pointer, because the command reference now lives in lyracore-cli. The README names the pinned Rust and SpacetimeDB versions. The quickstart says that doctor checks a floor and preflight an exact match. The "verified against the tree" headers go. README, SUPPORT and the architecture index send a contributor to CONTRIBUTING.md. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
CORE_TERMS.md holds the 32 terms a first change meets. CONTEXT.md stays the full glossary and gains an alphabetical index. The Runtime Script rules and the Package identifier ranges move to docs/package-api.md, and the Stat Kind codes to docs/schema.md. The glossary keeps one definition per term. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
AGENTS.md keeps the rules every agent follows. Realm operations, the CLI change procedure and the visual-work procedure move to docs/agents/maintainer.md, which AGENTS.md links as maintainer-only. No rule is dropped. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
CONTRIBUTING.md names itself, CODING_STANDARDS.md and CORE_TERMS.md as the required reads and lists the rest as lookup. docs/testing.md gives the unit, durable, binding and Runtime Script commands CI runs, the prerequisites and the client-data variables. The pull request template lists the same commands, the wasm check and the test-support crate included. danger-zones.md drops its stale test counts, which every deleted or added test made false. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Each recipe lists every file family and convention in order, binding regeneration and the schema append rule included. They are traced from the Meeting Stone Queue, the Instance Removal relay and the Distract effect on current main. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: GPT-6 Astra via Codex <noreply@openai.com>
Mathih13
force-pushed
the
docs/contributor-onboarding
branch
from
October 10, 2026 13:22
34db4ab to
85d8fd3
Compare
7 tasks done
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.
A new contributor met a reading list before their first change. Four documents each claimed to be the start, and the required reading was about 13,600 words. The tree also held research, triage output, a retired design, spikes, production host scripts and the maintainer's agent runbook next to contributor material.
This is phase 2 of #635. It changes no behaviour.
Reading path
CONTRIBUTING.mdnames three required reads: itself,CODING_STANDARDS.mdand a newCORE_TERMS.mdwith 32 terms. These come to 3,155 words. Everything else is "look it up when needed". The README, SUPPORT.md and the architecture index no longer compete as a start page.CONTEXT.mdstays the full glossary and gains an alphabetical index. The Runtime Script rules and the Package identifier ranges move todocs/package-api.md. The Stat Kind table moves todocs/schema.md.AGENTS.mdkeeps the contributor rules. Realm operations, visual work and CLI changes move todocs/agents/maintainer.md.docs/testing.md(one command per test tier), plus recipes for adding an opcode and adding a spell effect.lyracore-test-support.Attic
docs/research,docs/triage,docs/history,docs/issue-26-research.md,docs/region-sharding.md,content/regions/andspikes/. Git history is the archive. The last commit that holds them isb8113305.docs/verification/with one index. Their text is unchanged..claude/tickets/is no longer tracked. The gitignore already excluded it.deploy/moves to lyracore-cli #65, together with its CI job.deploy/systemd/spacetimedb-standalone.servicestays here, because the pinned CLI reads it from this path.docs/development-cli.mdpoints at the CLI repository's command reference.Every relative link and anchor in the 56 tracked markdown files resolves. Some Rust comments still cite deleted docs. Phase 1 fixes them in its comment sweep.
Implemented with Claude Opus 5.5 through Claude Code. Rebase, review corrections and PR management by GPT-6 Astra through Codex in T3 Code.