Skip to content

docs: lp2p: update#259

Open
swift1337 wants to merge 9 commits intomainfrom
docs/lp2p-update
Open

docs: lp2p: update#259
swift1337 wants to merge 9 commits intomainfrom
docs/lp2p-update

Conversation

@swift1337
Copy link
Member

No description provided.

@swift1337 swift1337 self-assigned this Mar 19, 2026
@swift1337 swift1337 requested a review from evanorti March 19, 2026 22:06
@greptile-apps
Copy link

greptile-apps bot commented Mar 19, 2026

Greptile Summary

This PR substantially rewrites and expands the lib-p2p experimental documentation for CometBFT, restructuring it with Mintlify UI components (Warning, Info), adding new configuration sections for the Queue Scaler and Resource Manager, a new Metrics reference section, and registering the page in the site navigation (docs.json). The Combined Mode section has been removed and replaced with a reference to AdaptiveSync.

  • Documentation restructure: Sections reorganized with clearer headings, Mintlify Warning/Info callouts, and improved prose throughout.
  • New configuration examples: Expanded config.toml snippets covering [p2p.libp2p.scaler] and [p2p.libp2p.limits] with tuning guidance.
  • New CLI example: Added cometbft show-node-id --libp2p snippet for printing a node's lib-p2p peer ID.
  • Metrics section added: Lists key Prometheus metric names for queue-scaler and resource tuning.
  • Navigation: lib-p2p page added to the Experimental group in docs.json.
  • Minor issues: A grammatical error ("alongside with" → "alongside"), a missing sentence-ending period in the first Warning block, trailing whitespace in a TOML comment, a missing colon on the Metrics section intro, and a missing newline at end of docs.json.

Confidence Score: 4/5

  • This PR is safe to merge; it is a documentation-only change with no functional code impact.
  • All changes are documentation and navigation config. No logic, security, or runtime issues were found. The only concerns are minor prose and formatting nits (grammatical error, missing punctuation, trailing whitespace, missing EOF newline) that do not affect functionality.
  • No files require special attention beyond the minor style nits noted in the inline comments.

Important Files Changed

Filename Overview
cometbft/next/docs/experimental/lib-p2p.mdx Substantial rewrite of the lib-p2p documentation: restructured with Mintlify Warning/Info components, added Queue Scaler and Resource Manager configuration sections, a new Metrics section, updated TOML config examples, and removed the Combined Mode section. Minor issues found: grammatical error ("alongside with"), missing period in Warning block, trailing whitespace in a TOML comment, and missing punctuation on the Metrics intro line.
docs.json Adds cometbft/next/docs/experimental/lib-p2p to the Experimental navigation group. The only issue is a missing newline at end of file.

Last reviewed commit: "add cli notes"

swift1337 and others added 3 commits March 19, 2026 23:10
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
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