Skip to content

docs: improve readme structure - #576

Merged
MegaRedHand merged 1 commit into
mainfrom
update-readme
Aug 11, 2026
Merged

docs: improve readme structure#576
MegaRedHand merged 1 commit into
mainfrom
update-readme

Conversation

@MegaRedHand

Copy link
Copy Markdown
Collaborator

Reorganize sections and update community and contributing information.

🗒️ Description / Motivation

  • What does this PR change?
  • Why is this change needed?
  • What problem does it solve?

What Changed

  • List the files or areas touched
  • Brief summary of each change

Correctness / Behavior Guarantees

  • What invariants are preserved or updated?
  • Are there any behavior changes reviewers should know about?

Tests Added / Run

  • What tests were added or updated?
  • What commands did you run to verify this change?

Related Issues / PRs

  • Closes #
  • Related to #

✅ Verification Checklist

  • Ran make fmt — clean
  • Ran make lint (clippy with -D warnings) — clean
  • Ran make test (cargo test --workspace --profile release-fast) — all passing

Reorganize sections and update community and contributing information.

@greptile-apps greptile-apps Bot 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.

Your trial has ended. Reactivate Greptile to resume code reviews.

Comment thread README.md

For custom devnet configurations, go to `lean-quickstart/local-devnet/genesis/validator-config.yaml` and edit the file before running the command above. See `lean-quickstart`'s documentation for more details on how to configure the devnet.

## Contributing

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Moved to the bottom of the readme

@github-actions

Copy link
Copy Markdown

🤖 Kimi Code Review

This PR contains documentation-only changes to README.md with no code modifications. Here is the review:

No code correctness, security, or consensus issues found — the diff consists solely of markdown section reorganization.

Documentation structure observations:

  1. Line 82-85: The new Documentation section correctly uses relative linking (./docs) alongside the absolute URL. Consider verifying the docs.ethlambda.xyz domain is properly configured and HTTPS-enabled, as this is the primary entry point for new users.

  2. Line 144-154: Moving "Community" and "Contributing" to the end follows standard open-source documentation conventions (users see technical content first, engagement second). This improves readability.

  3. Line 82: The use of the book emoji (## 📖 Documentation) introduces inconsistency with other headers that use plain text. While not blocking, consider removing the emoji for consistency with the minimalist philosophy described in line 86+.

Action required: None. The PR is safe to merge.


Note: As this contains no Rust code, consensus logic, or cryptographic implementations, no security audit of execution paths, memory safety, or SSZ/XMSS validation was applicable.


Automated review by Kimi (Moonshot AI) · kimi-k2.5 · custom prompt

@github-actions

Copy link
Copy Markdown

🤖 Codex Code Review

No findings.

This PR only reorganizes README.md content and adds a documentation section at README.md. It does not modify Rust code, consensus logic, SSZ handling, signature verification, networking, or any state transition / fork choice paths, so I do not see correctness, security, or performance risk from the diff as submitted.

Residual note: I did not run tests because the change is documentation-only and there are no executable code changes to validate.


Automated review by OpenAI Codex · gpt-5.4 · custom prompt

@github-actions

Copy link
Copy Markdown

🤖 Claude Code Review

Confirmed: both CONTRIBUTING.md and docs/ exist, so the relative links are valid. This PR is safe to merge as a docs-only reorganization — no functional or correctness issues found.


Automated review by Claude (Anthropic) · sonnet · custom prompt

@MegaRedHand
MegaRedHand merged commit cd6c468 into main Aug 11, 2026
6 checks passed
@MegaRedHand
MegaRedHand deleted the update-readme branch August 11, 2026 20:19
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.

2 participants