README.md update and other docs#13
Closed
Soph wants to merge 8 commits into
Closed
Conversation
Entire-Checkpoint: 533e5ecea6e2
Entire-Checkpoint: 66be830a0035
Entire-Checkpoint: 54f79acd90fe
Entire-Checkpoint: 31a1bc75e426
Soph
force-pushed
the
soph/docs-update-for-oss-release
branch
from
920f6ba to
972266c
Compare
pjbgf
reviewed
Apr 29, 2026
Entire-Checkpoint: 239b908e6c4e
pjbgf
reviewed
Apr 29, 2026
Co-authored-by: Paulo Gomes <paulo@entire.io>
pjbgf
approved these changes
Apr 29, 2026
Co-authored-by: Rizel Scarlett <rizel@entire.io>
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
3 participants
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.
Entire-Checkpoint: 533e5ecea6e2
Note
Low Risk
Documentation-only changes (plus adding standard policy/license files) with no runtime or API behavior modifications.
Overview
Adds project governance/policy docs (
CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md) plus an MITLICENSE.Reworks
README.mdto be shorter and more task-oriented: updated positioning, streamlined command list, refreshed examples (notably emphasizingsyncauto-bootstrapping and--target-max-pack-bytes), clarified JSON output, and a consolidated documentation index.Expands and updates docs around relay behavior: introduces new guides for
incremental relay,protocolinternals, andreplicate, and revisesbootstrap/bootstrap-batching/testingdocs to reflect current behavior (e.g., trunk-aware batched planning, tag handling, and updated test/task guidance).Reviewed by Cursor Bugbot for commit 8aab5f7. Configure here.