Skip to content

[Docs] Make saved environments optional in source-control setup - #3593

Open
roomote-roomote[bot] wants to merge 1 commit into
developfrom
fix/docs-source-control-prerequisites-1z7vb6z2k1wyp
Open

roomote-roomote[bot] wants to merge 1 commit into
developfrom
fix/docs-source-control-prerequisites-1z7vb6z2k1wyp

Conversation

@roomote-roomote

Copy link
Copy Markdown
Contributor

​Created by Roomote. View the session or mention @roomote-roomote for follow-up asks.

Related issue

Weekly public documentation health review; no separate issue.

Why this PR exists

  • A maintainer explicitly invited this PR in the linked issue or discussion
  • I am a maintainer / this is internal Roomote work

What changed

Correct the Source control overview's saved-environment prerequisite. Explain that a connected repository can run a task directly with a sandbox provider, link the existing first-task walkthrough, and make the verification checklist and PR-management introduction consistent with that path.

Why this change was made

The first-task guide already documents repository-only execution, and taskLaunchRequestSchema accepts a repository with an optional environment ID. Requiring a saved environment in the source-control setup checklist sends readers through unnecessary setup. Current open PRs and issues were checked; the pending corrections in #3468, #3514, #3515, and #3466 are not duplicated.

Impact

Documentation-only change to apps/docs/source-control.mdx (+8/-3). Readers can connect repositories and verify a task without first creating an environment. No runtime, navigation, redirect, configuration, generated-index, or icon changes.

How it was tested

  • mise exec -- pnpm --filter @roomote/docs build: passed repository-defined Mintlify build validation (not a static export).
  • mise exec -- pnpm --filter @roomote/docs check: passed full Mintlify validation and broken-link check on baseline and final text.
  • mise exec -- pnpm --filter @roomote/docs check-cookbook-index: passed, seven recipes; generation produced no changes.
  • Supplementary structural audit: 123 MDX pages; 115 unique navigation/root references resolve; every referenced page has title and icon; local icon assets and both redirect targets exist; recipe sidebar policy passes. All 41 named Lucide icons resolve in the current catalog. Preexisting optional-description warning on Live Previews remains.
  • Reviewed the entire affected page's rendered text, desktop (1440×1000) and mobile (390×844) layouts, and all eight rendered sidebar groups. Page width matches viewport at both sizes. Three exact screenshots opened and visually inspected, then independently checked against the unchanged diff. Desktop shows every revised passage; mobile evidence is representative rather than every revised sentence.
  • Existing external provider-logo images failed to load in the preview and public-site audit browser. Browser requests reported 404; an independent mediated SVG fetch returned 403. Lucide navigation icons render, but this run does not establish provider-logo quality for other clients. The existing lime selection contrast is weak. Neither issue is part of this prose-only fix.
  • git diff --check and all normal pre-push gates passed: oxlint, residual web/worker ESLint, 27 package typechecks, and Knip. Commit-time Judgement returned incomplete for two prose criteria (evidence/judgment collection failed); it allowed the commit, and those criteria were manually reviewed. It is not a successful automated judgment.
  • No live source-control authorization or task launch, full Vitest suite, or formatting-inclusive pnpm lint / pnpm check-types for this prose-only change.

Checklist

  • The PR title follows the repo convention: [Fix], [Feat], [Improve], [Refactor], [Docs], or [Chore] followed by a user-facing description
  • This PR is small and scoped to one change
  • pnpm lint and pnpm check-types pass locally
  • I added tests or included a clear manual validation note above
  • I removed secrets, tokens, private keys, and customer data from code, logs, and screenshots
  • If this change should appear in the changelog, I ran pnpm changeset

No changeset is needed for this documentation-only correction.

Screenshots

Genuine local Mintlify rendering with no mocks or simulated state. These demonstrate documentation appearance, not live task execution or provider authorization. Missing provider logos and weak selected-link contrast are disclosed above.

Desktop revised source-control setup and task-management guidance

Mobile optional-environment guidance

Mobile expanded source-control navigation

@roomote-community

roomote-community Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

No issues found. Reviewed the source-control documentation changes against the first-task guide, task-launch schema and handler, source-control tool implementation, and applicable repository guidance. Current-head docs validation, lint, typecheck, and test checks passed; Docker build and JavaScript/TypeScript CodeQL were still running when checked. See session

Reviewed 01d3e1b

@roomote-roomote
roomote-roomote Bot marked this pull request as ready for review October 26, 2026 14:22

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant