fix(ci): resolve OOM issues when building docs locally with Docusaurus Faster + sync docs with latest build result#38486
Conversation
…s Faster Also sync docs with latest build result Signed-off-by: hainenber <dotronghai96@gmail.com>
![bito-code-review[bot]](https://avatars.githubusercontent.com/in/1061978?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review Agent Run #d115de
Actionable Suggestions - 4
-
docs/developer_docs/api.mdx - 4
- Grammatical error in possessive form · Line 73-73
- Grammatical error in possessive form · Line 78-78
- Incorrect term hyphenation in link · Line 180-180
- Inconsistent API doc links and text · Line 366-369
Additional Suggestions - 1
-
docs/developer_docs/components/ui/progressbar.mdx - 1
-
Incorrect Import Path in Docs · Line 198-198The import path '@superset/components' does not exist in the codebase; the ProgressBar component is exported as a named export from '@superset-ui/core/components'. This change to default import syntax from an invalid path will cause import errors for users following this documentation.
Code suggestion
--- docs/developer_docs/components/ui/progressbar.mdx +++ docs/developer_docs/components/ui/progressbar.mdx @@ -197,1 +197,1 @@ -import ProgressBar from '@superset/components'; +import { ProgressBar } from '@superset-ui/core/components';
-
Review Details
-
Files reviewed - 9 · Commit Range:
b03eb09..b03eb09- docs/developer_docs/api.mdx
- docs/developer_docs/components/index.mdx
- docs/developer_docs/components/ui/button.mdx
- docs/developer_docs/components/ui/progressbar.mdx
- docs/developer_docs/components/ui/slider.mdx
- docs/developer_docs/components/ui/tablecollection.mdx
- docs/developer_docs/components/ui/tabs.mdx
- docs/developer_docs/components/ui/tree.mdx
- docs/docusaurus.config.ts
-
Files skipped - 1
- docs/src/data/databases.json - Reason: Filter setting
-
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.
Documentation & Help
AI Code Review powered by
…ady increased to 8GB Signed-off-by: hainenber <dotronghai96@gmail.com>
Signed-off-by: hainenber <dotronghai96@gmail.com>
…Docusaurus Faster Signed-off-by: hainenber <dotronghai96@gmail.com>
There was a problem hiding this comment.
Code Review Agent Run #7d0e49
Actionable Suggestions - 1
-
docs/scripts/docusaurus.mjs - 1
- NODE_OPTIONS overwrite bug · Line 38-40
Additional Suggestions - 1
-
docs/netlify.toml - 1
-
Build reliability risk · Line 37-38Removing the NODE_OPTIONS heap size increase could lead to out-of-memory errors during the Docusaurus build process, especially given that Superset docs include versioned documentation and internationalization. Docusaurus v3 builds can be memory-intensive, and while recent versions have optimizations, large sites may still require explicit heap allocation. Consider testing the build in Netlify or restoring the setting if failures occur.
-
Review Details
-
Files reviewed - 3 · Commit Range:
b03eb09..6dae02a- docs/docusaurus.config.ts
- docs/netlify.toml
- docs/scripts/docusaurus.mjs
-
Files skipped - 1
- docs/package.json - Reason: Filter setting
-
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.
Documentation & Help
AI Code Review powered by
Signed-off-by: hainenber <dotronghai96@gmail.com>
codeant-ai-for-open-source
Bot
added
the
size:L
![codeant-ai-for-open-source[bot]](https://avatars.githubusercontent.com/u/151810221?s=60&v=4){kind=small}
Code Review Agent Run #9f377fActionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
Code Review Agent Run #a6f559Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
Code Review Agent Run #f9a174Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
Signed-off-by: hainenber <dotronghai96@gmail.com>
hainenber
force-pushed
the
fix/resolve-oom-issues-when-building-docs-with-docusaurus-faster
branch
from
9a4dcab to
a6a93cd
Compare
codeant-ai-for-open-source
Bot
added
size:L
There was a problem hiding this comment.
Code Review Agent Run #b9726a
Actionable Suggestions - 12
-
docs/developer_docs/api.mdx - 9
- Broken documentation link · Line 71-71
- Broken documentation link · Line 74-74
- Broken documentation link · Line 75-75
- Broken documentation link · Line 76-76
- Broken documentation link · Line 87-87
- Incorrect hyphenation of class name · Line 252-252
- Broken documentation link · Line 327-327
- Broken documentation link · Line 328-328
- Broken documentation link · Line 338-338
-
docs/developer_docs/components/ui/tabs.mdx - 1
- Incorrect Import Path in Docs · Line 215-215
-
docs/developer_docs/components/ui/tablecollection.mdx - 1
- Incorrect import path causes runtime error · Line 58-58
-
docs/developer_docs/components/ui/tree.mdx - 1
- Incorrect import path in documentation · Line 260-260
Additional Suggestions - 2
-
docs/netlify.toml - 1
-
Potential OOM risk in docs build · Line 37-38Reducing the Node.js heap size from 8192MB to 4096MB could lead to out-of-memory errors during the docs build process on Netlify, especially if the Docusaurus site has many pages or complex content. The previous comment indicated this was needed for webpack bundling, and while the docs use Docusaurus, large builds can still be memory-intensive. If this change was intentional for cost optimization, monitor build logs closely for failures.
Code suggestion
@@ -37,2 +37,2 @@ - NODE_OPTIONS = "--max-old-space-size=4096" - + # Increase heap size for webpack bundling of Superset UI components + NODE_OPTIONS = "--max-old-space-size=8192"
-
-
docs/developer_docs/api.mdx - 1
-
Appropriate terminology improvement · Line 204-204Changing 'SqlLab' to 'SQL Lab' enhances clarity by expanding the acronym.
-
Review Details
-
Files reviewed - 11 · Commit Range:
b03eb09..a6a93cd- docs/developer_docs/api.mdx
- docs/developer_docs/components/index.mdx
- docs/developer_docs/components/ui/button.mdx
- docs/developer_docs/components/ui/progressbar.mdx
- docs/developer_docs/components/ui/slider.mdx
- docs/developer_docs/components/ui/tablecollection.mdx
- docs/developer_docs/components/ui/tabs.mdx
- docs/developer_docs/components/ui/tree.mdx
- docs/docusaurus.config.ts
- docs/netlify.toml
- docs/scripts/docusaurus.mjs
-
Files skipped - 2
- docs/package.json - Reason: Filter setting
- docs/src/data/databases.json - Reason: Filter setting
-
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.
Documentation & Help
AI Code Review powered by
…with-docusaurus-faster
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
codeant-ai-for-open-source
Bot
added
size:L
Code Review Agent Run #54a10fActionable Suggestions - 0Additional Suggestions - 1
Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
|
@rusackas the OOM issue was still ongoing locally on my machine even after your SSG crash fix PR (thanks to that, btw!). This PR would help fixing that, fyi :D |
codeant-ai-for-open-source
Bot
added
size:L
|
Heya... this looks pretty great to me, and would love to merge it, but there's a WALL of bot comments that may or may not have been addressed along the way, and a rebase is needed. Can you "Resolve conversaion" on any bot comments that you've dealt with or don't intend to? |
…with-docusaurus-faster Signed-off-by: hainenber <dotronghai96@gmail.com>
…use `future.faster` Signed-off-by: hainenber <dotronghai96@gmail.com>
hainenber
force-pushed
the
fix/resolve-oom-issues-when-building-docs-with-docusaurus-faster
branch
from
05db16d to
465600f
Compare
|
I've resolved all outdated comments and rebased. The docs is still good in the Netlify's preview link :D 
|
There was a problem hiding this comment.
Code Review Agent Run #dbd313
Actionable Suggestions - 3
-
docs/developer_docs/api.mdx - 3
- Inconsistent API descriptions · Line 598-641
- Typo in link text · Line 614-616
- API Naming Inconsistency · Line 133-141
Review Details
-
Files reviewed - 2 · Commit Range:
e810399..465600f- docs/developer_docs/api.mdx
- docs/docusaurus.config.ts
-
Files skipped - 1
- docs/src/data/databases.json - Reason: Filter setting
-
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
Bito Usage Guide
Commands
Type the following command in the pull request comment and save the comment.
-
/review- Manually triggers a full AI review. -
/pause- Pauses automatic reviews on this pull request. -
/resume- Resumes automatic reviews. -
/resolve- Marks all Bito-posted review comments as resolved. -
/abort- Cancels all in-progress reviews.
Refer to the documentation for additional commands.
Configuration
This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.
Documentation & Help
AI Code Review powered by
…with-docusaurus-faster
…ppets (#39649) Co-authored-by: Claude <claude@anthropic.com> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Code Review Agent Run #264db4Actionable Suggestions - 0Review Details
Bito Usage GuideCommands Type the following command in the pull request comment and save the comment.
Refer to the documentation for additional commands. Configuration This repository uses Documentation & Help AI Code Review powered by |
|
Opened a PR taking the AST approach rather than regex/perl-ish stuff :) Approving this PR either way. Feel free to merge the new PR into here if you prefer it :D |
hainenber
deleted the
fix/resolve-oom-issues-when-building-docs-with-docusaurus-faster
branch
…s Faster + sync docs with latest build result (apache#38486) Signed-off-by: hainenber <dotronghai96@gmail.com> Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Claude <claude@anthropic.com> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
…s Faster + sync docs with latest build result (apache#38486) Signed-off-by: hainenber <dotronghai96@gmail.com> Co-authored-by: Evan Rusackas <evan@preset.io> Co-authored-by: Claude <claude@anthropic.com> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
2 participants
User description
fix(ci): resolve OOM issues when building docs locally with Docusaurus Faster + sync docs with latest build result
SUMMARY
Temporarily disable SWC loader when building docs locally as it results in OOM error. This PR also synchronizes the docs with generated changes from the
yarn buildscriptsAs Netlify has been configured heap space to 8GB, we can build docs using Docusaurus Faster in Netlify's env without issue.
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before
After
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION
CodeAnt-AI Description
Prevent OOM when building docs locally and sync generated docs (adds Google Datastore, updates component docs and API titles)
What Changed
Impact
✅ Fewer local doc build OOMs✅ Clearer component examples in docs✅ Up-to-date database compatibility and install guidance💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.