docs: add --timeout option to create-prd and cleanup sidebar by subsy · Pull Request #54 · subsy/ralph-tui

subsy · 2026-01-14T22:01:59Z

Summary

Documentation updates for the create-prd command and sidebar improvements:

Added --timeout option documentation
- Documented --timeout, -t <ms> option in create-prd command
- Added examples for disabling timeout (--timeout 0)
- Explained that 0 = no timeout and default is 180000ms
Removed non-functional search placeholder
- Removed the "Search docs..." placeholder from sidebar that was marked as "Search coming soon"
- This placeholder was never implemented and the working search is in the top navbar
Made version badge dynamic
- Version in sidebar footer now reads from npm_package_version environment variable
- No longer hardcoded (was showing v0.1.3 while package.json is at v0.1.5)

Summary by CodeRabbit

New Features
- Added --timeout CLI option to configure AI agent call timeout durations (default 180,000 ms, with 0 disabling timeout).
Documentation
- Added comprehensive documentation with examples for timeout configuration and customisation.
Chores
- Updated sidebar version display and UI refinements.

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

- Added --timeout, -t option documentation for PRD creation - Added examples for disabling timeout (--timeout 0) - Removed non-functional search placeholder from sidebar - Made version badge dynamic using npm_package_version env var

vercel · 2026-01-14T22:02:04Z

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

Project	Deployment	Review	Updated (UTC)
ralph-tui	Ready	Preview, Comment	Jan 14, 2026 10:08pm

coderabbitai · 2026-01-14T22:02:10Z

Warning

Rate limit exceeded

@subsy has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 8 minutes and 58 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between d814e52 and ef8fcc2.

📒 Files selected for processing (2)

website/components/docs/Sidebar.tsx
website/next.config.mjs

Walkthrough

The pull request updates the sidebar component to dynamically display version information from build-time environment variables instead of hardcoded values, and adds documentation for a new --timeout CLI option for the create-prd command with configurable AI agent call timeouts.

Changes

Cohort / File(s)	Summary
Version Management `website/components/docs/Sidebar.tsx`	Introduced version constant from npm_package_version environment variable with '0.0.0' fallback; removed search placeholder UI block; replaced hardcoded v0.1.3 with dynamic v{version} in footer.
CLI Documentation `website/content/docs/cli/create-prd.mdx`	Added --timeout (short -t) CLI option documentation for AI agent calls; specified default 180000 ms and 0 for no timeout; included disable timeout examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A version springs to life from env,
No more hardcoded, now so deft,
And timeout options hop along,
Making our CLI swift and strong!
The docs now dance, the config's bright,
All working perfect—just right! ✨

🚥 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 accurately captures the main changes: documentation additions for the --timeout option and sidebar cleanup including version badge dynamisation.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@website/components/docs/Sidebar.tsx`:
- Around line 14-18: The client component Sidebar.tsx currently reads
process.env.npm_package_version in the const version, which is undefined in
browser builds; fix by exposing the version to the client: either set a
NEXT_PUBLIC_VERSION env var and replace process.env.npm_package_version with
process.env.NEXT_PUBLIC_VERSION (or inject NEXT_PUBLIC_VERSION at build), or
move the version resolution out of the 'use client' Sidebar into a server
component/page that reads process.env.npm_package_version (or next.config.mjs
env) and pass the resolved version down to Sidebar via a prop named version;
update references to the const version in Sidebar to use the passed prop if you
choose the server-prop approach.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 22073b5 and d814e52.

📒 Files selected for processing (2)

website/components/docs/Sidebar.tsx
website/content/docs/cli/create-prd.mdx

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{js,ts,jsx,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

Start all code files with a file-level JSDoc comment section explaining the file's purpose, prefixed with 'ABOUTME: '

Files:

website/components/docs/Sidebar.tsx

**/*.{js,ts,tsx,jsx}

📄 CodeRabbit inference engine (AGENTS.md)

Start all code files with a file-level JSDoc comment section explaining the file's purpose, prefixed with "ABOUTME: "

Files:

website/components/docs/Sidebar.tsx

🔇 Additional comments (4)

website/components/docs/Sidebar.tsx (2)

1-5: ABOUTME comment present and compliant.

The file-level JSDoc comment correctly explains the file's purpose with the required ABOUTME: prefix. As per coding guidelines, this is compliant.

101-101: Version interpolation looks correct.

The template literal syntax for displaying the version is appropriate, assuming the version constant is correctly populated.

website/content/docs/cli/create-prd.mdx (2)

33-33: Option documentation is clear and complete.

The --timeout option is well-documented with both short (-t) and long (--timeout) flags, units (milliseconds), default value (180000), and the special case (0 = no timeout).

68-76: Examples section is helpful and well-structured.

The "Disable Timeout" section provides practical examples with inline comments explaining the values. The 10-minute example with 600000 milliseconds and the explanatory comment is particularly helpful for users unfamiliar with millisecond conversions.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

website/components/docs/Sidebar.tsx

The previous approach using process.env.npm_package_version failed because that env var is only available in Node.js builds, not the browser client bundle. This fix: - Reads version from package.json in next.config.mjs - Exposes it via the env config as NEXT_PUBLIC_VERSION - Sidebar now uses process.env.NEXT_PUBLIC_VERSION (safe for client)

…eanup docs: add --timeout option to create-prd and cleanup sidebar

vercel bot deployed to Preview January 14, 2026 22:02 View deployment

coderabbitai bot reviewed Jan 14, 2026

View reviewed changes

website/components/docs/Sidebar.tsx Outdated Show resolved Hide resolved

vercel bot deployed to Preview January 14, 2026 22:08 View deployment

subsy merged commit c19e47c into main Jan 14, 2026
5 checks passed

coderabbitai bot mentioned this pull request Jan 14, 2026

chore: release v0.1.6 #55

Merged

sakaman pushed a commit to sakaman/ralph-tui that referenced this pull request Feb 15, 2026

Merge pull request subsy#54 from subsy/docs/timeout-option-sidebar-cl…

27a45ff

…eanup docs: add --timeout option to create-prd and cleanup sidebar

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add --timeout option to create-prd and cleanup sidebar#54

docs: add --timeout option to create-prd and cleanup sidebar#54
subsy merged 2 commits intomainfrom
docs/timeout-option-sidebar-cleanup

subsy commented Jan 14, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jan 14, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 14, 2026 •

edited

Loading

Rate limit exceeded

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

subsy commented Jan 14, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Summary by CodeRabbit

Uh oh!

vercel bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

subsy commented Jan 14, 2026 •

edited by coderabbitai bot

Loading

vercel bot commented Jan 14, 2026 •

edited

Loading

coderabbitai bot commented Jan 14, 2026 •

edited

Loading