Skip to content

docs: surface community channels on README and docs landing page#369

Merged
pablodeymo merged 2 commits into
mainfrom
docs/community-section-readme-and-docs
May 14, 2026
Merged

docs: surface community channels on README and docs landing page#369
pablodeymo merged 2 commits into
mainfrom
docs/community-section-readme-and-docs

Conversation

@MegaRedHand
Copy link
Copy Markdown
Collaborator

Summary

  • Add a Community section to the README and docs/introduction.md so newcomers find the Telegram group, the weekly Friday community call, and the PQ Interop calls without digging into CONTRIBUTING.md.
  • Refresh the existing Communication section in CONTRIBUTING.md to match (adds the weekly call and PQ Interop pointers, tightens the Telegram description).

Triggered by the follow-up in #368 (comment).

Test plan

  • README.md renders the new Community section between Contributing and Philosophy.
  • docs/introduction.md renders the new Community section before Related projects (will show up in the mdBook).
  • CONTRIBUTING.md Communication block stays consistent with the other two.

Communication info was only in CONTRIBUTING.md and missing the weekly
community call and the PQ Interop coordination pointer. Mirror a
consistent Community section across README.md, docs/introduction.md
and CONTRIBUTING.md so newcomers find it without digging.

Closes the follow-up noted in #368 (comment)
@github-actions
Copy link
Copy Markdown

🤖 Claude Code Review

Here is my review of PR #369:


PR #369 — docs: surface community channels on README and docs landing page

Overview: Pure documentation change. Adds a "Community" section to README.md and docs/introduction.md, and refreshes the existing "Communication" section in CONTRIBUTING.md to match. No code changes.


What this PR does

  • Surfaces Telegram, X/Twitter, the weekly Friday community call, and the PQ Interop calls in two high-visibility entry points (README and the mdBook introduction) so newcomers don't have to dig into CONTRIBUTING.md to find them.
  • Keeps CONTRIBUTING.md consistent with the new wording.

Review

Content and consistency

The four-item list is identical across README.md and docs/introduction.md, which is correct. CONTRIBUTING.md carries the same items plus a fifth ("GitHub Issues") that the other two omit — this is a defensible difference since that file is already contributor-focused, but worth being intentional about. If the intent is full parity, add the GitHub Issues bullet to the Community sections in README and docs; if the intent is to keep Community = social channels only, that's equally valid.

Placement

  • README.md: between Contributing and Philosophy — logical flow for a newcomer scanning top-to-bottom.
  • docs/introduction.md: before Related projects — good; community context before technical comparisons reads naturally.

Link durability

The PQ Interop pointer links to https://github.com/ethereum/pm/issues/2055, a specific GitHub issue. If that issue is eventually closed or the calls move to a new tracking issue, the link goes stale. Consider whether a more stable anchor (e.g., a wiki page or a pinned Telegram post) would be more resilient long-term. This is a minor concern given the ecosystem is still young.

Writing quality

Clean, friendly tone that fits a community-facing section. Sentence-casing on bullet labels is consistent. The semicolon usage in the Telegram entry ("daily updates; drop by…") is correct.

No issues with rendering: Markdown links are well-formed; the mdBook will pick up docs/introduction.md correctly.


Summary

This is a well-scoped, low-risk documentation change. The only actionable question is whether README.md and docs/introduction.md should also carry the "GitHub Issues" bullet for full parity with CONTRIBUTING.md. Everything else looks good — ready to merge once that decision is made explicitly.


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

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 14, 2026

Greptile Summary

This PR surfaces community channels in three places — README.md, docs/introduction.md, and CONTRIBUTING.md — so newcomers can find the Telegram group, the weekly Friday call, and the PQ Interop calls without hunting through CONTRIBUTING.md first.

  • README.md & docs/introduction.md: A new "Community" section is added with four identical bullet points (Telegram, X/Twitter, weekly call, PQ Interop).
  • CONTRIBUTING.md: The existing "Communication" section is updated to match the new wording, adding the weekly call and PQ Interop bullets and tightening the Telegram description.

Confidence Score: 5/5

Documentation-only change adding community links; no code or configuration is touched.

All three files receive the same four community-channel bullets, the wording is consistent, the external links point to the correct destinations, and no existing content is removed. There is nothing here that could introduce a regression.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds a new "Community" section between Contributing and Philosophy with four consistent bullet points covering Telegram, X, weekly call, and PQ Interop.
docs/introduction.md Adds the same four-bullet Community section before the Related projects section; content is identical to README.md.
CONTRIBUTING.md Expands the existing Communication section with matching wording: richer Telegram description, weekly call bullet, and PQ Interop pointer; drops "Follow" from the X entry.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Newcomer visits project] --> B{Which entry point?}
    B --> C[README.md]
    B --> D[docs/introduction.md]
    B --> E[CONTRIBUTING.md]
    C --> F[Community section\nTelegram · X · Weekly call · PQ Interop]
    D --> F
    E --> G[Communication section\nTelegram · X · Weekly call · PQ Interop · GitHub Issues]
    F --> H[Telegram group]
    F --> I[X @ethlambda_lean]
    F --> J[Friday community call via @class_lambda]
    F --> K[PQ Interop calls]
Loading

Reviews (1): Last reviewed commit: "docs: surface community channels on READ..." | Re-trigger Greptile

@github-actions
Copy link
Copy Markdown

🤖 Kimi Code Review

This PR contains documentation-only changes (no Rust code). Consequently, standard consensus-layer security review criteria (XMSS verification, SSZ encoding, fork choice, etc.) do not apply.

Review Summary

Status: Approved with minor formatting notes.

Non-code observations

  1. Link consistency (cosmetic)

    • CONTRIBUTING.md line 148 and README.md line 61: The X/Twitter link uses twitter.com while the weekly community call link (line 149/62) uses x.com. Consider standardizing on x.com for consistency since it is the current canonical domain.
  2. Documentation synchronization

    • The new "Community" section is correctly replicated across README.md (lines 58–64), docs/introduction.md (lines 32–38), and CONTRIBUTING.md (lines 147–151). Content is consistent.
  3. Punctuation normalization

    • CONTRIBUTING.md line 150: Good cleanup changing "Bugs" to lowercase "bugs" and adding terminal punctuation to match the declarative style of the new items.
  4. Placement

    • The Community section insertion in README.md (between contribution guidelines and Philosophy) and docs/introduction.md (after infographics) is logical for discoverability.

No blockers. The changes improve contributor onboarding and community visibility without introducing technical debt.


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

@github-actions
Copy link
Copy Markdown

🤖 Codex Code Review

No findings.

PR 369 is documentation-only. The changes are limited to the new community/contact section in README.md, CONTRIBUTING.md, and docs/introduction.md, so there is no effect on fork choice, attestation handling, justification/finalization, state transition logic, XMSS verification, SSZ encoding, security-critical paths, or runtime performance.

The only minor maintainability risk is that the same block is now duplicated in three places, so future edits will need to keep them synchronized. I did not run tests because this diff does not change executable code.


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

Comment thread docs/introduction.md Outdated
Link to the title-filtered ethereum/pm issues list so the reference
stays valid as new weekly issues open, and note that the meeting
links are posted on each issue.
@pablodeymo pablodeymo merged commit fc66a05 into main May 14, 2026
5 checks passed
@pablodeymo pablodeymo deleted the docs/community-section-readme-and-docs branch May 14, 2026 16:20
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