Skip to content

docs: stop pointing contributors at the repositories being archived - #4261

Merged
bgm-malbeclabs merged 3 commits into
mainfrom
migrate/decommission-sources
Sep 2, 2026
Merged

docs: stop pointing contributors at the repositories being archived#4261
bgm-malbeclabs merged 3 commits into
mainfrom
migrate/decommission-sources

Conversation

@bgm-malbeclabs

Copy link
Copy Markdown
Contributor

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.md is removed. It 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: 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.
  • DEVELOPMENT gains a section on the two imported trees, naming what the root make targets do not reach: the Solana L1 programs, which keep their own workspace, lockfile and 1.91 toolchain so their bytes stay reproducible against sha256sums_*.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:

This repository has moved. The code now lives in
malbeclabs/doublezero, under offchain/,
with its full history and its release tags. This repository is archived and read-only.
Open issues and pull requests against malbeclabs/doublezero.

Existing releases and their download URLs continue to resolve here. New releases are
published from malbeclabs/doublezero.

Same text for doublezero-solana, with solana/ 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-shreds keeps resolving malbeclabs/doublezero-solana at tag revenue-distribution/v0.3.7, and that tag imported here points at the same commit. Shreds can be repointed when it suits.

Testing Verification

  • Searched both imported trees for links to the source repositories outside changelogs and release links. offchain/CONTRIBUTING.md was the only live pointer; offchain/Cargo.toml also carried repository and homepage fields naming the old repo, and workspace: fold the offchain crates into the root workspace #4255 deletes that file outright.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ 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.

Comment thread ruleset-main-backup.json Outdated
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch 2 times, most recently from 6268088 to a4baf65 Compare September 1, 2026 22:43
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch from a4baf65 to b8723b2 Compare September 1, 2026 23:00
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/offchain-sync branch 2 times, most recently from e822d07 to 91c4c04 Compare September 1, 2026 23:53
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch 2 times, most recently from 7343d9e to e087926 Compare September 2, 2026 00:30
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/offchain-sync branch 2 times, most recently from 87f5f88 to a282552 Compare September 2, 2026 00:32
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch 2 times, most recently from 20b6f3e to df469f9 Compare September 2, 2026 00:42
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch from df469f9 to c01d96f Compare September 2, 2026 00:58
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch 2 times, most recently from 339bb68 to ceb857b Compare September 2, 2026 01:06
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch from ceb857b to f538b3f Compare September 2, 2026 01:11
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/offchain-sync branch 2 times, most recently from ae27171 to e0abc55 Compare September 2, 2026 02:01
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch from f538b3f to 862cf7e Compare September 2, 2026 02:01
Base automatically changed from migrate/offchain-sync to main September 2, 2026 03:06
@martinsander00
martinsander00 requested a review from a team September 2, 2026 03:06
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.
Copilot AI lite review requested due to automatic review settings September 2, 2026 03:47
@bgm-malbeclabs
bgm-malbeclabs force-pushed the migrate/decommission-sources branch from 862cf7e to f00ad0d Compare September 2, 2026 03:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.md into the root README.md, and delete the obsolete contributing file.
  • Add a new “imported trees” section to DEVELOPMENT.md that explains what root make targets 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.

Comment thread DEVELOPMENT.md Outdated
Comment thread README.md Outdated
bgm-malbeclabs and others added 2 commits September 2, 2026 13:07
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>
@bgm-malbeclabs
bgm-malbeclabs enabled auto-merge (squash) September 2, 2026 04:08
@bgm-malbeclabs
bgm-malbeclabs merged commit 5c136af into main Sep 2, 2026
41 checks passed
@bgm-malbeclabs
bgm-malbeclabs deleted the migrate/decommission-sources branch September 2, 2026 04:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants