docs: add docs for start and end index flags

[swarna1101]

Summary by CodeRabbit

• Documentation
  • Expanded docs for multi-node publish/subscribe: added guidance for selecting IP subsets using -start-index and -end-index, with zero-based indexing, exclusive end behavior, validation rules, defaults, and examples. Clarifies behavior when end-index exceeds file length and retains default start/end values for backward compatibility.

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

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• .gitignore is excluded by !.gitignore and included by **.gitignore

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request updates docs/guide.md to add detailed documentation for two new index-range flags used by multi-node publish and subscribe commands: -start-index and -end-index. The docs describe zero-based indexing, end-exclusive semantics, validation constraints (start-index >= 0, start-index < end-index, start-index < total IPs), behavior when end-index exceeds file length, default values (implicit start-index=0, end-index large/default to file length), and examples demonstrating subset selection. No executable code or public API signatures were changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single documentation file modified with homogeneous content additions
• No code logic, configuration, or executable changes to evaluate
• Review focus: confirm flag descriptions, validation rules, examples match actual behavior and existing CLI semantics

Pre-merge checks and finishing touches

❌ Failed checks (3 warnings)

Check name	Status	Explanation	Resolution
Go Build And Test Rationale	⚠️ Warning	Pull request lacks test coverage for new index-handling logic and exhibits validation inconsistency between multi-publish and multi-subscribe tools.	Add comprehensive unit tests for index validation and matching validation logic to multi-publish to enforce the same three constraints as multi-subscribe.
Concurrency Safety	⚠️ Warning	Documentation claims identical validation in multi-publish and multi-subscribe, but implementation shows multi-publish lacks validation that multi-subscribe has, and untracked goroutines in receive loop create concurrency safety violations.	Update documentation to reflect actual validation differences. Fix goroutine leak in multi-subscribe by tracking goroutines with sync.WaitGroup or handling responses synchronously. Add missing validation to multi-publish to match multi-subscribe constraints.
Security Considerations	⚠️ Warning	Documentation claims identical validation between multi-publish and multi-subscribe, but multi-publish lacks validation of critical index constraints (start-index >= 0, start-index < end-index, start-index < total IPs), creating unvalidated input handling risks.	Implement matching validation constraints in multi-publish or update documentation to clarify which tool validates which constraints and document graceful error handling for invalid indices.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: documentation additions for start and end index flags, directly corresponding to the PR's objectives and the changeset in docs/guide.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Public Api Changes	✅ Passed	This pull request introduces no breaking changes to exported types, functions, or public APIs. The changes consist entirely of documentation updates to docs/guide.md, explaining existing CLI flags (-start-index and -end-index) for the multi-node publishing and subscribing tools written in Go. These are command-line arguments, not exported type definitions or public function signatures. Since no exported APIs are modified or introduced, no CHANGELOG entry or migration note is required under this custom check.
Rust Best Practices	✅ Passed	PR contains only documentation updates to docs/guide.md describing flags; no Rust test code changes subject to custom check criteria.

---

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

[coderabbitai]

Actionable comments posted: 1

📜 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 5f774f6 and db6c005.

📒 Files selected for processing (1)

• docs/guide.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*

⚙️ 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:

• docs/guide.md

**/*.md

⚙️ CodeRabbit configuration file

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

Files:

• docs/guide.md

⏰ 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

[hpsing]

add .tsv in .gitignore too

[swarna1101]

add .tsv in .gitignore too

done