Skip to content

[Feat] Add contextual setup documentation#724

Merged
brunobergher merged 18 commits into
developfrom
feature/setup-docs-guide-3a7vpuc91vay6
Jul 24, 2026
Merged

[Feat] Add contextual setup documentation#724
brunobergher merged 18 commits into
developfrom
feature/setup-docs-guide-3a7vpuc91vay6

Conversation

@roomote-roomote

@roomote-roomote roomote-roomote Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Opened on behalf of Bruno Bergher. Follow up by mentioning @roomote-roomote, in the web UI, or in Slack.

What changed

  • Added a persistent desktop setup documentation panel that renders mapped Roomote docs in-app, with an option to open the current page in a new tab.
  • Mapped bootstrap, communications, model, source-control, sandbox, and environment steps to relevant docs, including provider-specific pages when the selected provider is known.
  • Added the supporting docs-content loader, MDX components, and build asset sync so setup can render public documentation without an iframe.
  • Reworked setup page composition and removed the dormant setup qualification flow.
  • Fixed the setup docs test to query the button's actual accessible name.

Why this change was made

First-time setup asks users to configure several provider and environment concepts. Keeping the relevant Roomote documentation beside the active step reduces context switching, while rendering the content in-app avoids the public docs site's framing restrictions.

Impact

Desktop setup users receive step-aware guidance without leaving Roomote; mobile setup remains unchanged. The updated targeted test, web type check, lint, and pre-push checks pass.

@roomote-roomote

roomote-roomote Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

No new code issues found. See task

  • apps/web/src/app/(onboarding)/setup/SetupDocs.tsx:59: The docs site sends X-Frame-Options: DENY and a frame-ancestors CSP that excludes Roomote, so every embedded documentation page is blocked. Use an allowed framing endpoint or open the contextual docs outside an iframe.
  • apps/web/src/app/(onboarding)/setup/SetupDocs.client.test.tsx:53: The test now queries the button's full accessible name, Need help? Docs are here, so the selector matches the rendered accessible name.

Reviewed 373ae7b

@brunobergher
brunobergher marked this pull request as ready for review July 24, 2026 18:07
@roomote-roomote

roomote-roomote Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

Fixed the CI failure by adding the missing Info icon export to the repository-selection test mock and pushed 373ae7b. The previously failing repository-selection test suite now passes, and the pre-push checks passed. GitHub CI has been re-triggered by the push.

@brunobergher
brunobergher merged commit 069c9cf into develop Jul 24, 2026
17 checks passed
@brunobergher
brunobergher deleted the feature/setup-docs-guide-3a7vpuc91vay6 branch July 24, 2026 18:52
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.

2 participants