docs: sharpen README#206
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <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
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.
Summary
Rewrote the README to be sharper and more accurate against the actual workspace and source, without growing it for its own sake.
What changed and why
The previous README listed actors and crates that no longer match the code (e.g. "Transport crate / Messages crate" prose, "Gateway" rather than the current Portal terminology) and omitted several crates that exist today.
The new README is verified against:
Cargo.toml,crates/*/Cargo.toml): seven crates documented exactly as named:sqd-network-transport,sqd-messages,sqd-assignments,sqd-contract-client,sqd-bootnode,sqd-keygen,sqd-observer.crates/transport/src: actor list and the Cargo feature gates (worker,portal,observer,pings-collector,logs-collector,portal-logs-collector,sql-client) taken fromCargo.toml [features]andlib.rsexports.crates/messages/proto/messages.protoandbuild.rs: confirms prost/protobuf schemas and the Worker/Scheduler/Portal/collector message flow (the proto comments call the role Portal, previously Gateway).crates/assignments/schema/assignment.fbsandlib.rs: FlatBuffers assignment format withbuilder/readerfeatures.crates/contract-client/src: reads onchain registries/allocations over an RPC node via ethers.Dockerfileand.github/workflows/docker.yml: build targets and the three published images (subsquid/bootnode,subsquid/keygen,subsquid/observer); kept the keygen Docker example, updated the tag to:latest(confirmed present on Docker Hub).crates/transport/src/cli.rsandcrates/observer/src/cli.rsfor the Configuration table.rust-toolchain(1.89.0) and theprotobuf-compilerbuild dependency from the Dockerfile.AGPL-3.0-or-later; rootLICENSE.mdis AGPLv3. License line updated to match.Crates are not published to crates.io (verified 404 in the sparse index), so no crates.io links were added.
Style compliance
🤖 Generated with Claude Code