Skip to content

docs: sharpen README#206

Merged
karelxfi merged 1 commit into
mainfrom
seo/readme-sharpen
Jun 16, 2026
Merged

docs: sharpen README#206
karelxfi merged 1 commit into
mainfrom
seo/readme-sharpen

Conversation

@karelxfi

Copy link
Copy Markdown
Contributor

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 workspace (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 from Cargo.toml [features] and lib.rs exports.
  • crates/messages/proto/messages.proto and build.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.fbs and lib.rs: FlatBuffers assignment format with builder/reader features.
  • crates/contract-client/src: reads onchain registries/allocations over an RPC node via ethers.
  • Dockerfile and .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).
  • CLI flags from crates/transport/src/cli.rs and crates/observer/src/cli.rs for the Configuration table.
  • rust-toolchain (1.89.0) and the protobuf-compiler build dependency from the Dockerfile.
  • License: all crates declare AGPL-3.0-or-later; root LICENSE.md is 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

  • No marketing words, no em dashes, no emojis.
  • "onchain" written as one word.
  • Every link verified returning 200: docs.sqd.dev/en/network, sqd.dev, the network-architecture wiki, rust-libp2p, ethers-rs.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@karelxfi karelxfi merged commit 496602b into main Jun 16, 2026
3 checks passed
@karelxfi karelxfi deleted the seo/readme-sharpen branch June 16, 2026 16:40
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.

1 participant