Skip to content

Conversation

@hannesrudolph
Copy link
Collaborator

@hannesrudolph hannesrudolph commented Jan 28, 2026

Based on the work from PR #10943.

This PR migrates the standalone Roo-Code-Docs repository into the Roo-Code monorepo as apps/docs.

Summary of Changes

Documentation Migration

  • Moved all documentation files, components, and static assets from Roo-Code-Docs to apps/docs
  • Created new @roo-code/docs package with monorepo-compatible dependencies
  • Changed @roo-code/types dependency to workspace:^ for tighter integration

Configuration Updates

  • Updated docusaurus.config.ts editUrl to point to apps/docs/ path in monorepo
  • Fixed @roo-code/types package.json to export built files instead of source files (prevents Webpack resolution errors)
  • Added missing Docusaurus dependencies: @docusaurus/plugin-content-docs, @docusaurus/theme-common, @easyops-cn/autocomplete.js
  • Updated turbo.json to include docs-specific build outputs (.docusaurus/**, build/**)

Build & Type Fixes

  • Fixed TypeScript error with inert attribute in MobileSidebar component
  • Added .gitignore for docs to exclude build artifacts
  • Successfully tested build with pnpm --filter @roo-code/docs build

Documentation

  • Created comprehensive README at apps/docs/README.md with:
    • Development setup instructions
    • Environment variable configuration
    • Vercel deployment setup guide
    • Documentation writing guidelines

Deployment Setup Required

GitHub Actions Workflows

Two workflow files need to be manually added (GitHub App lacks workflow permissions):

  • .github/workflows/docs-deploy.yml - Deploy to Vercel on push to main
  • .github/workflows/docs-preview.yml - Deploy preview on PR

These files are available in the unstaged changes.

Vercel Configuration

Required secrets in GitHub repository settings:

  • VERCEL_TOKEN - Personal Access Token from Vercel
  • VERCEL_ORG_ID - Organization ID from Vercel
  • VERCEL_DOCS_PROJECT_ID - Project ID for docs
  • POSTHOG_API_KEY - PostHog analytics key (optional)
  • INTERCOM_APP_ID - Intercom widget ID (optional)

Vercel project settings:

  • Root Directory: apps/docs
  • Build Command: pnpm build
  • Output Directory: build
  • Install Command: pnpm install --frozen-lockfile
  • Node Version: 20.x
  • Custom Domain: docs.roocode.com

Post-Merge Tasks

  1. Add GitHub Actions workflows manually
  2. Configure Vercel project with the settings above
  3. Archive the Roo-Code-Docs repository with a redirect notice
  4. Update any external links pointing to the old repository

View task on Roo Code Cloud

@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. Documentation Improvements or additions to documentation labels Jan 28, 2026
@ellipsis-dev
Copy link
Contributor

ellipsis-dev bot commented Jan 28, 2026

⚠️ This PR is too big for Ellipsis, but support for larger PRs is coming soon. If you want us to prioritize this feature, let us know at help@ellipsis.dev


Generated with ❤️ by ellipsis.dev

@roomote
Copy link
Contributor

roomote bot commented Jan 28, 2026

Oroocle Clock   See task on Roo Cloud

Re-review complete. No outstanding issues.

  • Fix incorrect CI workflow reference in apps/docs/AGENTS.md (mentions .github/workflows/docusaurus-build.yml which doesn’t exist in this repo)
Previous reviews

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

@hannesrudolph hannesrudolph force-pushed the feat/migrate-docs-to-monorepo branch from 328d40d to 172f552 Compare January 28, 2026 21:06
@hannesrudolph hannesrudolph force-pushed the feat/migrate-docs-to-monorepo branch from 8da7a0e to 87009d3 Compare January 29, 2026 02:51
- Add docs app with Docusaurus configuration
- Sync content from Roo-Code-Docs repository
- Configure webpack extensionAlias for monorepo TS resolution
- Maintain consistency: @roo-code/types exports source files
- Add docs:dev, docs:build, docs:serve convenience scripts
- Fix broken provider references (claude-code, human-relay)
@hannesrudolph hannesrudolph force-pushed the feat/migrate-docs-to-monorepo branch from 87009d3 to afb80b5 Compare January 29, 2026 02:55
The reference to .github/workflows/docusaurus-build.yml was incorrect as
this workflow doesn't exist in the monorepo. Updated to reflect that CI
injects environment variables via Vercel configuration.
Copy link
Collaborator

@mrubens mrubens left a comment

Choose a reason for hiding this comment

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

I'm no longer sure this is the right direction, since we also want to be able to document cloud features. Let's discuss more.

@github-project-automation github-project-automation bot moved this from New to Done in Roo Code Roadmap Jan 29, 2026
@github-project-automation github-project-automation bot moved this from Triage to Done in Roo Code Roadmap Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants