-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Add apps/docs #8324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add apps/docs #8324
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Generated with ❤️ by ellipsis.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found some issues that need attention; see inline comments for details.
| "rewrites": [ | ||
| { | ||
| "source": "/docs", | ||
| "destination": "/index.html" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P1: With baseUrl set to "/docs/" in docusaurus.config, rewriting "/docs" to "/index.html" will likely 404 or serve the wrong root. Suggest rewriting to "/docs/index.html".
| "destination": "/index.html" | |
| "destination": "/docs/index.html" |
| }, | ||
| { | ||
| "source": "/docs/(.*)", | ||
| "destination": "/$1" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P1: For nested routes, preserve the "/docs" prefix so static assets resolve correctly.
| "destination": "/$1" | |
| "destination": "/docs/$1" |
| language: ["en"], | ||
| highlightSearchTermsOnTargetPage: true, | ||
| explicitSearchResultPath: true, | ||
| docsRouteBasePath: "/docs", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: docsRouteBasePath should match the docs preset's routeBasePath (currently "/").
| docsRouteBasePath: "/docs", | |
| docsRouteBasePath: "/", |
| "clsx": "^2.0.0", | ||
| "posthog-docusaurus": "^2.0.4", | ||
| "prism-react-renderer": "^2.3.0", | ||
| "react": "^19.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: Docusaurus v3.8.x is validated on React 18. React 19 may be incompatible.
| "react": "^19.0.0", | |
| "react": "^18.3.1", |
| "prism-react-renderer": "^2.3.0", | ||
| "react": "^19.0.0", | ||
| "react-cookie-consent": "^9.0.0", | ||
| "react-dom": "^19.0.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: Ensure react-dom matches React 18.
| "react-dom": "^19.0.0", | |
| "react-dom": "^18.3.1", |
| @@ -0,0 +1,35 @@ | |||
| name: Docusaurus Build Check | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P1: GitHub Actions must live at ".github/workflows/" in the repository root. Files under "apps/docs/.github/workflows" won't run. Move this workflow to the root and (optionally) switch to pnpm for workspace installs.
| @@ -0,0 +1,2 @@ | |||
| # These owners will be the default owners for everything in the repo | |||
| * @mrubens @cte @hannesrudolph | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P1: CODEOWNERS is only recognized from repository root ("/CODEOWNERS"), root ".github/CODEOWNERS", or "/docs/CODEOWNERS". This file under "apps/docs/.github" will be ignored. Move to a supported location to enable reviewer assignment.
Move docs into the monorepo.