Migrate Roo-Code-Docs into monorepo as apps/docs #10943
Conversation
- Move all documentation files from standalone repo to apps/docs - Create @roo-code/docs package with workspace dependencies - Update docusaurus.config.ts editUrl to point to apps/docs path - Fix @roo-code/types package.json to export built files instead of source - Add missing dependencies (@docusaurus/plugin-content-docs, @docusaurus/theme-common, @easyops-cn/autocomplete.js) - Update turbo.json to include docs build outputs - Add comprehensive README with setup instructions - Add .gitignore to exclude build artifacts - Fix TypeScript error with inert attribute This migration consolidates the docs into the main repository for better integration and streamlined deployment via Vercel. Note: GitHub Actions workflows for deployment will be added manually due to repository permissions.
dosubot
bot
added
size:XXL
Review complete. Found 1 issue that needs attention before merging.
Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
|
Generated with ❤️ by ellipsis.dev |
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
| */ | ||
|
|
||
| // GitHub repository information | ||
| export const GITHUB_REPO_URL = "https://github.com/RooCodeInc/Roo-Code-Docs" |
There was a problem hiding this comment.
GITHUB_REPO_URL still points to the old standalone repository (Roo-Code-Docs). Since this constant is used for the editUrl in docusaurus.config.ts with /apps/docs/ appended, the resulting "Edit this page" links will be broken - the path https://github.com/RooCodeInc/Roo-Code-Docs/edit/main/apps/docs/ doesn't exist. This should point to the main monorepo instead.
| export const GITHUB_REPO_URL = "https://github.com/RooCodeInc/Roo-Code-Docs" | |
| export const GITHUB_REPO_URL = "https://github.com/RooCodeInc/Roo-Code" |
Fix it with Roo Code or mention @roomote and request a fix.
This PR migrates the standalone Roo-Code-Docs repository into the Roo-Code monorepo as
apps/docs.Summary of Changes
Documentation Migration
Roo-Code-Docstoapps/docs@roo-code/docspackage with monorepo-compatible dependencies@roo-code/typesdependency toworkspace:^for tighter integrationConfiguration Updates
docusaurus.config.tseditUrlto point toapps/docs/path in monorepo@roo-code/typespackage.json to export built files instead of source files (prevents Webpack resolution errors)@docusaurus/plugin-content-docs,@docusaurus/theme-common,@easyops-cn/autocomplete.jsturbo.jsonto include docs-specific build outputs (.docusaurus/**,build/**)Build & Type Fixes
inertattribute in MobileSidebar component.gitignorefor docs to exclude build artifactspnpm --filter @roo-code/docs buildDocumentation
apps/docs/README.mdwith: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 PRThese files are available in the unstaged changes.
Vercel Configuration
Required secrets in GitHub repository settings:
VERCEL_TOKEN- Personal Access Token from VercelVERCEL_ORG_ID- Organization ID from VercelVERCEL_DOCS_PROJECT_ID- Project ID for docsPOSTHOG_API_KEY- PostHog analytics key (optional)INTERCOM_APP_ID- Intercom widget ID (optional)Vercel project settings:
apps/docspnpm buildbuildpnpm install --frozen-lockfiledocs.roocode.comPost-Merge Tasks
Roo-Code-Docsrepository with a redirect noticeView task on Roo Code Cloud