Skip to content

docs: add initial_path configuration for preview environment ports#519

Merged
jr merged 2 commits intomainfrom
feature/CLO-678-initial-path-config
Feb 6, 2026
Merged

docs: add initial_path configuration for preview environment ports#519
jr merged 2 commits intomainfrom
feature/CLO-678-initial-path-config

Conversation

@roomote
Copy link
Contributor

@roomote roomote bot commented Jan 30, 2026

This PR adds documentation for the new initial_path property in preview environment port configurations.

Changes

  • Added initial_path to the port configuration fields table
  • Added a dedicated "Initial Path" subsection explaining the feature and its use case
  • Documented validation rules (must start with /, valid URI path characters)
  • Added examples showing valid and invalid initial_path values
  • Updated the environment variable table to show how initial_path affects the resulting URL
  • Added "Initial Path" to the keywords in frontmatter

Use Case

Preview environments currently load a blank page at the root path, which does not work for applications where the entry point is at a different path (e.g., /login). The initial_path property allows users to specify the default path that will be appended to the preview URL when the service starts.


View task on Roo Code Cloud


Important

Adds documentation for initial_path configuration in preview environment ports, detailing its purpose, usage, and validation rules in environments.mdx.

  • Documentation:
    • Adds initial_path to port configuration fields in environments.mdx.
    • Introduces "Initial Path" subsection explaining its purpose and use case.
    • Documents validation rules for initial_path (must start with /, valid URI characters).
    • Updates environment variable table to show initial_path impact on URLs.
    • Adds examples of valid and invalid initial_path values.
  • Misc:
    • Adds "Initial Path" to keywords in frontmatter of environments.mdx.

This description was created by Ellipsis for 6619e59. You can customize this summary. It will automatically update as commits are pushed.

@vercel
Copy link

vercel bot commented Jan 30, 2026

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

Project Deployment Actions Updated (UTC)
roo-code-docs Ready Ready Preview, Comment Feb 6, 2026 3:10am

Request Review

@roomote
Copy link
Contributor Author

roomote bot commented Jan 30, 2026

Rooviewer Clock   See task on Roo Cloud

Review complete. Found 1 documentation inconsistency that should be clarified.

  • Clarify whether initial_path affects the environment variable value or only the UI preview URL (the table and text descriptions contradict each other)

Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues.

- Fix validation rules: query params and hash fragments are allowed
- Fix domain names: keep preview.roocode.cloud (revert vercel.run changes)
- Fix env var table: ROO_*_HOST contains base URL only, not initial_path
- Add note clarifying initial_path only affects UI preview links
- Update examples to include query params and hash fragments
@roomote
Copy link
Contributor Author

roomote bot commented Feb 6, 2026

Updated the docs to align with the latest cloud implementation of initial_path:

Changes:

  • Validation rules corrected: Query parameters and hash fragments are now documented as allowed (matching the cloud regex /^\/[a-zA-Z0-9\-._~:/?#[\]@!$&'()*+,;=%]*$/). Previously the docs incorrectly stated these were invalid.
  • Domain names fixed: Reverted vercel.run references back to preview.roocode.cloud to match the current production domain.
  • Env var table corrected: ROO_*_HOST environment variables contain the base URL only, not the initial path. Removed initial_path from the env var example row.
  • Added clarification note: A :::note block explains that initial_path only affects the UI preview link, not the ROO_*_HOST environment variable.
  • Updated valid examples: Added /login?redirect=home and /docs#getting-started as valid examples.

View task on Roo Code Cloud

@jr jr marked this pull request as ready for review February 6, 2026 04:11
@jr jr merged commit 9b4b827 into main Feb 6, 2026
3 checks passed
@jr jr deleted the feature/CLO-678-initial-path-config branch February 6, 2026 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: Triage

Development

Successfully merging this pull request may close these issues.

2 participants