docs: update guide and readme for refactored structure

[swarna1101]

Summary by CodeRabbit

• Documentation
  • Rebranded product name from OptimumP2P to mump2p across all user documentation, guides, and command-line output messages
  • Introduced comprehensive Multi-Node Client Tools section detailing usage and configuration for distributed peer operations
  • Updated setup instructions, examples, and troubleshooting resources to reflect new naming conventions

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This pull request rebrand the project from OptimumP2P to mump2p. Changes span five files: docker-compose-optimum.yml updates inline comments, readme.md and docs/guide.md replace all references in headings and examples, script/generate-identity.sh updates the success message, and grpc_p2p_client/shared/utils.go updates an error message. The documentation guide also adds a new "Multi-Node Client Tools" subsection with usage details. No functional logic or control flow is altered.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Most changes are homogeneous text replacements (OptimumP2P → mump2p) applied consistently across files, which reduces per-file reasoning effort
• Documentation updates in docs/guide.md include new subsections and restructuring but follow predictable patterns
• No functional code logic changes or complex interactions to evaluate
• The function signatures mentioned in the documentation summary appear to be documentation-only edits; verify that corresponding implementation changes in grpc_p2p_client/shared/utils.go align with the documented signatures

Possibly related PRs

• fix: refactor grpc_p2p_client to resolve multiple main() conflict #57: Both modify grpc_p2p_client/shared/utils.go and update trace handler function signatures and naming (HandleOptimumP2PTrace/HandleGossipSubTrace), suggesting coordinated refactoring of trace-handling infrastructure.
• Kmk grpc add example #53: Touches the same trace-handling code paths in grpc_p2p_client, potentially conflicting if both introduce different changes to GossipSub/mump2p trace handlers.

Suggested reviewers

• hpsing
• paiva

Pre-merge checks and finishing touches

❌ Failed checks (4 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Go Build And Test Rationale	⚠️ Warning	Repository lacks unit test coverage for non-trivial trace-handling functions that process external protobuf data, creating maintainability and regression-detection risks.	Establish unit tests for HandleOptimumP2PTrace and HandleGossipSubTrace covering valid/malformed protobuf unmarshaling, error handling, channel logic, and edge cases.
Concurrency Safety	⚠️ Warning	Code contains unbounded goroutine spawning, goroutine leaks in WriteToFile wrappers, missing context checks in async handlers, and channel close race conditions causing potential send-on-closed-channel panics.	Implement bounded goroutine processing with semaphore/worker pool, remove wrapper goroutines, add context cancellation checks, use sync/errgroup to track goroutines, and ensure all handlers complete before channel closure.
Public Api Changes	⚠️ Warning	Pull request introduces breaking API changes to exported Go functions without documentation or changelog entries.	Add CHANGELOG.md documenting breaking changes with before/after signatures and update docs/guide.md with migration instructions and code examples.
Title check	❓ Inconclusive	The title is vague and generic, using non-descriptive terms that don't clearly convey the actual scope of changes—primarily a product rebrand from OptimumP2P to mump2p across multiple files.	Consider a more specific title like 'refactor: rename OptimumP2P to mump2p across codebase' to accurately reflect the substantive changes being made beyond documentation structure updates.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Security Considerations	✅ Passed	PR contains predominantly documentation and branding updates with minimal functional code changes limited to error message text. No security vulnerabilities, injection vectors, or regressions introduced.
Rust Best Practices	✅ Passed	This pull request contains no Rust code files, only Go source files and configuration. The custom check for Rust best practices is not applicable.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/update-guide-for-refactored-structure

---

📜 Recent review details

Configuration used: Repository: getoptimum/coderabbit/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3bbe399 and f944928.

⛔ Files ignored due to path filters (1)

• metrics/grafana/dashboards/p2p-nodes.json is excluded by none and included by none

📒 Files selected for processing (5)

• docker-compose-optimum.yml (4 hunks)
• docs/guide.md (21 hunks)
• grpc_p2p_client/shared/utils.go (1 hunks)
• readme.md (9 hunks)
• script/generate-identity.sh (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

**/*

⚙️ CodeRabbit configuration file

**/*: When you find the same underlying issue in multiple locations (same pattern, same fix):

• Do NOT post separate comments for each occurrence.
• Post a single primary comment on the first occurrence.
• In that comment, include a short list of “Also at: file:line” references
  for the other locations (e.g. 'Also at: foo.go:42, bar.go:17').
  Prioritize signal over volume: one strong comment that references multiple
  locations is preferred over many near-identical comments.

Files:

• docker-compose-optimum.yml
• readme.md
• grpc_p2p_client/shared/utils.go
• docs/guide.md
• script/generate-identity.sh

**/*.md

⚙️ CodeRabbit configuration file

**/*.md: - Technical accuracy first; keep commands copy-pastable; prefer minimal prerequisites.

Files:

• readme.md
• docs/guide.md

**/*.go

📄 CodeRabbit inference engine (coderabbit-custom-pre-merge-checks-unique-id-file-non-traceable-F7F2B60C-1728-4C9A-8889-4F2235E186CA.txt)

**/*.go: Watch for goroutine leaks, unbounded channels, and racy access; ensure contexts are plumbed and respected
If code changes affect Go packages, verify that tests cover changed logic; flag risky changes lacking tests

Files:

• grpc_p2p_client/shared/utils.go

---

⚙️ CodeRabbit configuration file

Review Go code for: idiomatic patterns, error handling (check all errors), concurrency safety (context propagation, goroutine cleanup), test coverage for changed logic, exported API stability, memory efficiency (avoid unnecessary allocations), and prefer standard library over third-party when reasonable.

Files:

• grpc_p2p_client/shared/utils.go

**/*.sh

⚙️ CodeRabbit configuration file

Review the shell scripts, point out issues relative to security, performance, and maintainability.

Files:

• script/generate-identity.sh

🪛 LanguageTool

readme.md

[style] ~52-~52: Since ownership is already implied, this phrasing may be redundant.
Context: ...ation options - Help partners bootstrap their own network using mump2p **You are expecte...

(PRP_OWN)

🪛 markdownlint-cli2 (0.18.1)

docs/guide.md

92-92: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

93-93: Unordered list indentation
Expected: 4; Actual: 6

(MD007, ul-indent)

---

94-94: Unordered list indentation
Expected: 4; Actual: 6

(MD007, ul-indent)

---

95-95: Unordered list indentation
Expected: 4; Actual: 6

(MD007, ul-indent)

---

96-96: Unordered list indentation
Expected: 4; Actual: 6

(MD007, ul-indent)

---

105-105: Unordered list indentation
Expected: 4; Actual: 6

(MD007, ul-indent)

---

105-105: Link fragments should be valid

(MD051, link-fragments)

---

106-106: Unordered list indentation
Expected: 4; Actual: 6

(MD007, ul-indent)

---

107-107: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 2

(MD005, list-indent)

---

854-854: Bare URL used

(MD034, no-bare-urls)

---

1064-1064: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

1084-1084: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

1084-1084: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

1120-1120: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

1120-1120: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

1137-1137: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

1137-1137: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

1138-1138: Hard tabs
Column: 9

(MD010, no-hard-tabs)

---

1138-1138: Hard tabs
Column: 16

(MD010, no-hard-tabs)

---

1138-1138: Hard tabs
Column: 21

(MD010, no-hard-tabs)

---

1139-1139: Hard tabs
Column: 16

(MD010, no-hard-tabs)

---

1139-1139: Hard tabs
Column: 22

(MD010, no-hard-tabs)

---

1139-1139: Hard tabs
Column: 26

(MD010, no-hard-tabs)

---

1140-1140: Hard tabs
Column: 16

(MD010, no-hard-tabs)

---

1140-1140: Hard tabs
Column: 22

(MD010, no-hard-tabs)

---

1140-1140: Hard tabs
Column: 26

(MD010, no-hard-tabs)

---

1144-1144: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

1144-1144: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

1145-1145: Hard tabs
Column: 16

(MD010, no-hard-tabs)

---

1145-1145: Hard tabs
Column: 28

(MD010, no-hard-tabs)

---

1145-1145: Hard tabs
Column: 41

(MD010, no-hard-tabs)

---

1145-1145: Hard tabs
Column: 52

(MD010, no-hard-tabs)

---

1146-1146: Hard tabs
Column: 16

(MD010, no-hard-tabs)

---

1146-1146: Hard tabs
Column: 28

(MD010, no-hard-tabs)

---

1146-1146: Hard tabs
Column: 40

(MD010, no-hard-tabs)

---

1146-1146: Hard tabs
Column: 52

(MD010, no-hard-tabs)

---

1146-1146: Hard tabs
Column: 63

(MD010, no-hard-tabs)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Test Docker Setup

🔇 Additional comments (9)

script/generate-identity.sh (1)

87-87: LGTM! Clean rebranding update.

The success message now reflects the new project name consistently with other changes in the PR.

grpc_p2p_client/shared/utils.go (1)

160-160: LGTM! Error message updated consistently.

The decode error message now uses the new naming convention, aligning with the project rebrand.

docker-compose-optimum.yml (1)

56-56: LGTM! Inline comment updates are consistent.

The configuration comments now reflect the new project naming convention.

Also at: docker-compose-optimum.yml:86, docker-compose-optimum.yml:117, docker-compose-optimum.yml:148

readme.md (2)

1-27: LGTM! Clean rebrand and clear architecture documentation.

The title, project description, and architecture explanation now consistently use the new "mump2p" naming. The remote P2P node instructions are prominently placed for distributed testing.

---

99-123: Excellent addition of multi-node client documentation.

The new sections clearly distinguish between single-node and multi-node clients with concrete usage examples. The commands are copy-pastable and the reference to the detailed guide is helpful.

docs/guide.md (4)

1-28: LGTM! Comprehensive guide title and intro updated.

The guide now consistently uses "mump2p" naming throughout the title, introduction, and remote cluster connection examples.

---

212-239: Excellent documentation structure for client tools.

The clear separation between single-node and multi-node client usage with concrete examples makes it easy for users to choose the right tool. The cross-reference to the detailed Multi-Node Client Tools section is helpful.

---

1037-1168: Outstanding new multi-node client documentation section.

This comprehensive addition clearly documents:

• Three distinct client tools with their specific use cases
• Detailed usage examples with flags and output formats
• IP file format and configuration
• Clear guidance on when to use each client

The examples are copy-pastable and the TSV output format documentation is precise.

---

1297-1325: LGTM! Trace implementation documentation is accurate.

The function signatures documented here match the actual implementation in grpc_p2p_client/shared/utils.go, and the explanation of trace collection functionality is clear and technically accurate.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide your own instructions using the high_level_summary_instructions setting.
• Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
4. 📊 Contributor Summary — Include a Markdown table showing contributions:
   | Contributor | Lines Added | Lines Removed | Files Changed |
5. ✔️ Additional Notes — Add any extra reviewer context.
   Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}