fix(docs): resolve bun build issues and update component syntax#57
Conversation
- Fix docs site build issues with Bun isolated installs by removing problematic postinstall script - Update MDC component syntax to use u- prefix for docs-please compatibility - Add missing zod and better-sqlite3 dependencies to package.json - Bump docs-please to stable v0.2.5 and nuxt to v4.2.1 - Add NITRO_PRESET for proper Node server compatibility in dev mode Resolves documentation site build failures with Bun workspaces
Summary of ChangesHello @amondnet, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the stability and compatibility of the documentation site. It addresses critical build failures, especially when leveraging Bun, by refining package configurations, updating component syntax to align with Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request effectively addresses the build issues with the documentation site by updating dependencies, fixing component syntax, and refining the build configuration. The changes are well-summarized and logical. I have a couple of minor suggestions to further improve code quality and security.
| Get Started → | ||
| ::: | ||
|
|
||
| :::u-button{to="https://github.com/chatbot-pf/code-please" target="_blank" variant="outline" size="lg"} |
There was a problem hiding this comment.
For security reasons, it's best practice to add rel="noopener noreferrer" to any link that uses target="_blank". This helps prevent a type of vulnerability called 'tabnabbing', where the newly opened page can gain partial access to the original page.
| :::u-button{to="https://github.com/chatbot-pf/code-please" target="_blank" variant="outline" size="lg"} | |
| :::u-button{to="https://github.com/chatbot-pf/code-please" target="_blank" rel="noopener noreferrer" variant="outline" size="lg"} |
| "generate": "nuxt generate", | ||
| "preview": "nuxt preview", | ||
| "postinstall": "nuxt prepare" | ||
| "postinstall": "" |
Summary
Changes
Docs Site Fixes
u-prefix for docs-please compatibility::page-hero→::u-page-hero::page-section→::u-page-section::page-card-group→::u-page-grid::page-card→::u-page-card::button-linkto:::u-buttonDependencies
docs-pleasefrom^0.2.1-beta.0to^0.2.5(stable)nuxtto^4.2.1zod^4.2.1(required by docs-please)zod-to-json-schema^3.25.0(required by docs-please)better-sqlite3^12.2.0(required by docs-please)typescriptto devDependenciesBuild Configuration
NITRO_PRESET=node_serverin dev script for proper Node server compatibilitypostinstallscript that was causing issues with Bun isolated installs@pleaseai/code-please-docs-sitefor consistencyTest Plan
bun installin docs directorybun run devto verify dev server startsbun run buildto verify production build succeedsRelated
Fixes documentation site build failures with Bun workspaces