docs: stop pointing contributors at the repositories being archived - #4261
Conversation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit f2df3a9. Configure here.
c302215 to
3246f10
Compare
6268088 to
a4baf65
Compare
3246f10 to
551edc0
Compare
a4baf65 to
b8723b2
Compare
e822d07 to
91c4c04
Compare
7343d9e to
e087926
Compare
87f5f88 to
a282552
Compare
20b6f3e to
df469f9
Compare
a282552 to
5208077
Compare
df469f9 to
c01d96f
Compare
5208077 to
d02089a
Compare
339bb68 to
ceb857b
Compare
d02089a to
255bafc
Compare
ceb857b to
f538b3f
Compare
ae27171 to
e0abc55
Compare
f538b3f to
862cf7e
Compare
Step 6 of the monorepo migration, the part that lives in this repository. Archiving `doublezero-offchain` and `doublezero-solana` is a separate action on those repositories. `offchain/CONTRIBUTING.md` told contributors to fork `doublezero-offchain` and to open pull requests and issues against it. Both stop being true the moment that repository is archived. The rest of the file repeated what the root README already says, so the file goes and the one thing the root lacked, the code of conduct, moves there. DEVELOPMENT gains a short section on the two imported trees. The offchain crates are ordinary workspace members and the Quickstart targets cover them. The Solana L1 programs and the Elixir scheduler are not covered by anything at the root, and until now nothing said so.
862cf7e to
f00ad0d
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The new DEVELOPMENT instructions do not match the actual Elixir CI steps, and the README Code of Conduct link should use HTTPS.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates contributor-facing documentation for the monorepo migration by removing guidance that will become incorrect once the source repositories are archived, and by documenting how to work with the imported offchain/ and solana/ trees inside this repository.
Changes:
- Move the Contributor Covenant reference from
offchain/CONTRIBUTING.mdinto the rootREADME.md, and delete the obsolete contributing file. - Add a new “imported trees” section to
DEVELOPMENT.mdthat explains what rootmaketargets do not cover and which CI workflows apply. - Record the documentation changes in
CHANGELOG.md.
File summaries
| File | Description |
|---|---|
| README.md | Adds a project-wide Code of Conduct reference for contributors. |
| offchain/CONTRIBUTING.md | Removes outdated contribution instructions that point to soon-to-be-archived repos. |
| DEVELOPMENT.md | Documents how to run checks for the imported solana/ and Elixir scheduler trees. |
| CHANGELOG.md | Notes the documentation updates related to the archive and imported-tree workflows. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Step 6 of the monorepo migration, the half that lives in this repository. Archiving the two source repositories is an action on those repositories, and the text to use is below. Stacked on #4257, so the diff shown here is this change alone.
Summary
offchain/CONTRIBUTING.mdis removed. It told contributors to forkdoublezero-offchainand to open pull requests and issues against it. Both stop being true the moment that repository is archived: an archived repository takes no issues and no pull requests. Everything else in the file repeated the root README, and the one thing the root lacked, the Contributor Covenant reference, moves there.maketargets do not reach: the Solana L1 programs, which keep their own workspace, lockfile and 1.91 toolchain so their bytes stay reproducible againstsha256sums_*.txt, and the Elixir scheduler. Both now have their own path-scoped CI, which the section names.I checked the rest of both trees for pointers that stop being true after the archive. There is only one other class, and it should stay: the per-crate changelogs link to releases at
doublezero-offchain. Those releases exist there and an archived repository still serves them, so the links keep working. Rewriting historical release links would make them wrong, not right.For the archive itself
Both repositories keep their transfer redirects, their 11 forks and their old release download URLs, so archive them read-only rather than deleting. Suggested notice for the top of each README before archiving:
Same text for
doublezero-solana, withsolana/as the directory.Archiving is also what unblocks step 7, and the two are deliberately not the same day: an archived repository still serves reads, so
doublezero-shredskeeps resolvingmalbeclabs/doublezero-solanaat tagrevenue-distribution/v0.3.7, and that tag imported here points at the same commit. Shreds can be repointed when it suits.Testing Verification
offchain/CONTRIBUTING.mdwas the only live pointer;offchain/Cargo.tomlalso carriedrepositoryandhomepagefields naming the old repo, and workspace: fold the offchain crates into the root workspace #4255 deletes that file outright.