Skip to content

Docs: Update website for PR 258 parallel/remote features#260

Merged
subsy merged 1 commit intomainfrom
docs/pr-258-parallel-remote-features
Feb 3, 2026
Merged

Docs: Update website for PR 258 parallel/remote features#260
subsy merged 1 commit intomainfrom
docs/pr-258-parallel-remote-features

Conversation

@subsy
Copy link
Copy Markdown
Owner

@subsy subsy commented Feb 3, 2026 •
edited by coderabbitai bot
Loading

Summary

Updates website documentation to cover the new features from PR #258 (remote orchestration and smart parallelism heuristics).

Changes

website/content/docs/cli/run.mdx:

  • Added --task-range flag to options table
  • Added new "Task Range Filtering" section with:
    • Range format table (1-5, 3-, -10, 5)
    • Usage examples
    • Callout about parallel compatibility

website/content/docs/parallel/configuration.mdx:

  • Added new "Smart Parallelism Heuristics" section documenting:
    • How heuristics analyze task characteristics
    • Heuristic rules table (test tasks, refactor tasks, file overlap)
    • Examples showing heuristic behavior
    • How to override heuristics

website/content/docs/cli/remote.mdx:

  • Added new "Remote Parallel Orchestration" section with:
    • Overview of WebSocket-based control
    • Orchestration commands table
    • Start options table
    • TypeScript example for programmatic control
    • State response schema

website/content/docs/parallel/overview.mdx:

  • Updated "Next Steps" to link to remote orchestration docs

Test plan

  • bun run build in website/ succeeds
  • All MDX files parse correctly
  • Review rendered documentation for accuracy

Summary by CodeRabbit

Documentation

  • Added guidance on Remote Parallel Orchestration using WebSocket-based orchestration with ralph-tui server in listen mode, including server setup, orchestration commands, and usage examples
  • Documented new --task-range option for the run command to filter and execute specific task ranges with multiple supported formats
  • Added Smart Parallelism Heuristics section describing automatic worker count adjustment based on task type analysis and file overlap detection

Update docs for PR 258 parallel/remote features
7db6333 
Documents three new features from PR 258:

1. **Task Range Filtering** (`--task-range`):
   - Added flag to run.mdx options table
   - Added dedicated section with all range formats
   - Examples for common use cases

2. **Smart Parallelism Heuristics**:
   - New section in parallel/configuration.mdx
   - Explains automatic worker count adjustment
   - Documents test vs refactor task detection
   - Shows how to override heuristics

3. **Remote Parallel Orchestration**:
   - New section in remote.mdx
   - Documents all orchestrate: WebSocket commands
   - TypeScript example for programmatic control
   - State response schema documentation

Also updated parallel overview with link to remote orchestration.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 3, 2026 •
edited
Loading

Walkthrough

Adds documentation covering remote parallel orchestration via WebSocket, task-range filtering for the run command, and smart parallelism heuristics for worker configuration. All changes are documentation-only additions without modifications to runtime behaviour or existing code.

Changes

Cohort / File(s) Summary
Remote Orchestration Documentation
website/content/docs/cli/remote.mdx		 Introduces comprehensive documentation for WebSocket-based remote orchestration, covering server setup in listen mode, orchestration commands (start, pause, resume, stop, get_state), start options (maxWorkers, directMerge, maxIterations), and programmatic usage examples with state response schema.
Task Range Filtering
website/content/docs/cli/run.mdx		 Documents new --task-range option for the run command, describing 1-indexed task numbering, supported range formats (1-5, 3-, -10), usage examples, and interaction with sequential/parallel execution modes.
Parallelism Configuration & Navigation
website/content/docs/parallel/configuration.mdx, website/content/docs/parallel/overview.mdx		 Introduces Smart Parallelism Heuristics section with rules for adjusting worker count based on task analysis (test tasks, refactor tasks, file overlap). Updates overview navigation to reference smart heuristics and adds link to remote orchestration documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly describes the main change: updating website documentation for features from PR 258, which aligns with all file changes across cli/run, cli/remote, and parallel configuration/overview.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/pr-258-parallel-remote-features

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

coderabbitai[bot]
coderabbitai bot reviewed Feb 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents 
In `@website/content/docs/cli/run.mdx`:
- Line 282: In the sentence describing the `--task-range` flag (the line
containing "`--task-range` flag" and "Task indices are **1-indexed** for user
friendliness."), replace "user friendliness" with the hyphenated form
"user-friendliness" so the compound noun is correctly formatted.

@vercel
Copy link
Copy Markdown

vercel bot commented Feb 3, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ralph-tui Ready Ready Preview, Comment Feb 3, 2026 4:23pm

Request Review

@subsy subsy merged commit 173cc67 into main Feb 3, 2026
9 checks passed
sakaman pushed a commit to sakaman/ralph-tui that referenced this pull request Feb 15, 2026
@subsy
Merge pull request subsy#260 from subsy/docs/pr-258-parallel-remote-f…
9f6c275 
…eatures

Docs: Update website for PR 258 parallel/remote features
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@subsy