Skip to content

fix(docs): resolve bun build issues and update component syntax#57

Merged
amondnet merged 1 commit into
mainfrom
fix/docs-bun-compatibility
Dec 22, 2025
Merged

fix(docs): resolve bun build issues and update component syntax#57
amondnet merged 1 commit into
mainfrom
fix/docs-bun-compatibility

Conversation

@amondnet

Copy link
Copy Markdown
Contributor

Summary

  • Fix docs site build issues with Bun isolated installs
  • Update MDC component syntax to use u- prefix for docs-please compatibility
  • Add missing zod and better-sqlite3 dependencies
  • Remove problematic postinstall script that was breaking builds

Changes

Docs Site Fixes

  • Component Syntax: Updated all MDC components to use u- prefix for docs-please compatibility
    • Changed ::page-hero::u-page-hero
    • Changed ::page-section::u-page-section
    • Changed ::page-card-group::u-page-grid
    • Changed ::page-card::u-page-card
    • Updated button syntax from ::button-link to :::u-button

Dependencies

  • Bumped docs-please from ^0.2.1-beta.0 to ^0.2.5 (stable)
  • Updated nuxt to ^4.2.1
  • Added zod ^4.2.1 (required by docs-please)
  • Added zod-to-json-schema ^3.25.0 (required by docs-please)
  • Added better-sqlite3 ^12.2.0 (required by docs-please)
  • Added typescript to devDependencies

Build Configuration

  • Set NITRO_PRESET=node_server in dev script for proper Node server compatibility
  • Removed postinstall script that was causing issues with Bun isolated installs
  • Updated package name to @pleaseai/code-please-docs-site for consistency

Test Plan

  • Run bun install in docs directory
  • Run bun run dev to verify dev server starts
  • Run bun run build to verify production build succeeds
  • Verify all MDC components render correctly with u- prefix
  • Check that documentation site displays properly with all components

Related

Fixes documentation site build failures with Bun workspaces

- 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
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @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 docs-please requirements, and managing necessary dependencies. These changes collectively aim to establish a more robust and functional documentation platform.

Highlights

  • Docs Site Build Fixes: Resolved documentation site build failures, particularly when using Bun isolated installs, by adjusting package configurations and removing a problematic postinstall script.
  • Component Syntax Update: Updated MDC component syntax throughout the documentation to ensure compatibility with the docs-please library, introducing a u- prefix for various components like page-hero, page-section, page-card-group, page-card, and button-link.
  • Dependency Management: Added essential dependencies including zod, zod-to-json-schema, better-sqlite3, and typescript to meet requirements for docs-please and Nuxt, and updated several existing dependency versions.
  • Build Configuration Enhancements: Configured NITRO_PRESET=node_server for the development script to ensure proper Node server compatibility and updated the docs site package name for consistency.
  • LSP Timeout Adjustment: Reduced the Language Server Protocol (LSP) command timeout in hooks.json from 60 seconds to 30 seconds.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@amondnet
amondnet merged commit 204ef32 into main Dec 22, 2025
1 of 4 checks passed
@amondnet
amondnet deleted the fix/docs-bun-compatibility branch December 22, 2025 15:03

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

security-medium medium

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.

Suggested change
:::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"}

Comment thread apps/docs/package.json
"generate": "nuxt generate",
"preview": "nuxt preview",
"postinstall": "nuxt prepare"
"postinstall": ""

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve maintainability, it's cleaner to completely remove the postinstall script from the scripts object rather than leaving it as an empty string. This makes the package.json file tidier and more explicit about which scripts are in use.

@passionfactory-bot passionfactory-bot Bot mentioned this pull request Dec 22, 2025
@passionfactory-bot passionfactory-bot Bot mentioned this pull request Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant