scriptoriumadmin/Roo-Code
1
0
Fork 0
mirror of https://github.com/RooVetGit/Roo-Code.git synced 2026-09-06 08:18:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Roo-Code/apps/docs/AGENTS.md
Roo Code f1d69f02fb feat: migrate Roo-Code-Docs into monorepo as apps/docs 
- 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.
2026-01-24 19:30:01 +00:00

2.2 KiB
Raw Blame History

AGENTS.md

This file provides guidance to agents when working with code in this repository.

Non-obvious, project-specific rules:

  • Start/build preload dotenv; analytics plugin is enabled only when POSTHOG_API_KEY is set. Use .env based on .env.example. CI injects it in .github/workflows/docusaurus-build.yml. See package.json and docusaurus.config.ts.
  • Use Node 20 locally to match CI; engines allow >=18 but CI runs 20.
  • Linting targets only /src; docs content is not linted. Use "pnpm run lint:unused" to enforce unused import removal. Type checking uses "tsc" only (no emit); tsconfig.json is editor-focused.
  • When moving/renaming docs, you must add an explicit redirect in docusaurus.config.ts under plugin-client-redirects. This is required by .roorules.
  • Internal doc links must be absolute and extensionless per .roorules (example: /basic-usage/how-tools-work). Do not include ".md".
  • Images in docs must use HTML tags per .roorules: ....
  • Sitemap: preset sitemap is disabled; a custom plugin is configured in docusaurus.config.ts to filter URLs containing "/page/". Do not re-enable the preset sitemap.
  • Local search plugin is configured with docsRouteBasePath "/". Keep routeBasePath "/" consistent when adding content or links.
  • "Tutorial Videos" sidebar is generated from docs/tutorial-videos.json; titles are truncated to 40 chars in sidebars.ts. Modify the JSON to add/remove videos.
  • Navigation/footer links are centralized in src/constants.ts and consumed by docusaurus.config.ts. Update constants rather than hardcoding URLs.
  • Legacy Rakefile is unrelated (Jekyll). Do not use it; all builds run through Docusaurus scripts.
  • For structural/formatting research, use Context7 MCP (ID "/facebook/docusaurus") via .roo/mcp.json; see .roorules.
  • CI runs build and check-types (no lint). Run lint locally to catch issues CI won't.