docs: use npm commands for auto package manager tabs#11
Conversation
Replace manual pnpm/npm/bun commands with npm format to leverage automatic package manager tab conversion in CodeBlockCommand component.
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 streamlines the documentation for getting started by standardizing package installation and development commands. It leverages an existing feature that automatically generates package manager-specific tabs within code blocks, reducing manual maintenance and ensuring that users see the correct commands for their preferred package manager (npm, pnpm, yarn, bun) without explicit listing of each. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request simplifies the installation and setup documentation by leveraging an automatic tabbing feature for package manager commands. The changes replace specific commands for pnpm and bun with their npm equivalents, which improves maintainability. I've added one suggestion to align a configuration example in the documentation with the project's actual configuration to prevent potential user confusion. Overall, these are good changes that improve the documentation's consistency and user experience.
I am having trouble creating individual review comments. Click here to see my feedback.
apps/docs/content/docs/1.getting-started/2.installation.md (34-38)
The compatibilityDate in this documentation example ('2025-01-01') is inconsistent with the project's actual configuration file (apps/docs/nuxt.config.ts), which uses '2025-12-03'. To prevent potential confusion for users following this guide, it's best to keep the documentation aligned with the actual project setup. The suggested change updates the date and also incorporates the removal of the blank line.
export default defineNuxtConfig({
extends: ['docs-please'],
compatibilityDate: '2025-12-03',
})
Deploying docs-please with
|
| Latest commit: |
1c408fb
|
| Status: | ⚡️ Build in progress... |
* feat(layer): add 'd' shortcut to toggle color mode Press 'd' to toggle between light and dark color modes. The shortcut is configurable via app.config.ts (docs.shortcuts.toggleColorMode) and can be disabled by setting it to an empty string. The handler bails out when: - the color mode is forced (colorMode.forced === true) - the keystroke originated from an editable element (<input>, <textarea>, <select>, [contenteditable]) - any modifier key (meta / ctrl / alt / shift) is pressed Reimplemented from upstream docus commit 61c36d03 (feat(layer): add d shortcut to toggle color mode (#1377)) using @vueuse/core's onKeyStroke instead of @nuxt/ui's defineShortcuts, since this project does not depend on @nuxt/ui. Refs: docs/docus-upstream-changes.md item #11 * fix(layer): apply review suggestions for color mode shortcut Applies feedback from gemini-code-assist review: - Explicitly import `computed` from vue for IDE/test environments - Traverse up the DOM in `isEditableTarget` so non-HTMLElement targets (SVGElement, MathMLElement) inside contenteditable containers are still treated as editable and do not trigger the shortcut
1 participant
Summary
pnpm devwithnpm run devChanges
apps/docs/content/docs/1.getting-started/2.installation.mdTest plan