Docs: Update install docs for --type with current project type values #33122
Conversation
valentinpalkovic
requested review from
jonniebigodes and
kylegach
as code owners
valentinpalkovic
force-pushed
the
valentin/edit-install-instruction-cli-flags
branch
2 times, most recently
from
236b5eb to
23a4433
Compare
valentinpalkovic
added
documentation
ci:docs
|
Warning Rate limit exceeded@valentinpalkovic has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 16 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughInstallation docs updated to require or recommend passing the project type via Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/get-started/install.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-05T09:38:47.712Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.
Applied to files:
docs/get-started/install.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (1)
docs/get-started/install.mdx (1)
169-189: Documentation structure and clarity are solid.The reorganization from narrative guidance to an explicit instruction + mapping table is a clear improvement. The table is:
- Alphabetically sorted by type (good for usability)
- Properly formatted markdown syntax
- Contextually placed in the appropriate troubleshooting section
- Clearly labeled with descriptive framework names
The instruction text ("If auto‑detection fails or you're using a custom setup, pass the project type explicitly with
--type...") is direct and actionable.
|
View your CI Pipeline Execution ↗ for commit 53d502e
☁️ Nx Cloud last updated this comment at |
… (lowercase, underscore-separated)
valentinpalkovic
force-pushed
the
valentin/edit-install-instruction-cli-flags
branch
from
23a4433 to
ae30054
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/get-started/install.mdx(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Core Unit Tests, windows-latest
| If auto‑detection fails or you’re using a custom setup, pass the project type explicitly with `--type` when running the initializer. The allowed values are: | ||
|
|
||
| | Type | Framework | | ||
| | ----------------------------- | ---------------------------------- | | ||
| | `angular` | Angular | | ||
| | `ember` | Ember | | ||
| | `html` | HTML | | ||
| | `nextjs` | Next.js | | ||
| | `nuxt` | Nuxt | | ||
| | `preact` | Preact | | ||
| | `qwik` | Qwik | | ||
| | `react` | React | | ||
| | `react_native` | React Native | | ||
| | `react_native_web` | React Native Web | | ||
| | `react_native_and_rnw` | React Native Web | | ||
| | `react_scripts` | Create React App (react-scripts) | | ||
| | `react_project` | React Project | | ||
| | `server` | Server renderer | | ||
| | `solid` | Solid | | ||
| | `svelte` | Svelte | | ||
| | `sveltekit` | SvelteKit | | ||
| | `vue3` | Vue 3 | | ||
| | `web_components` | Web Components | |
There was a problem hiding this comment.
🧩 Analysis chain
Clarify the distinction between react_native_web and react_native_and_rnw project types.
Both type values (lines 182 and 183) have identical framework descriptions: "React Native Web". This creates ambiguity about when to use each type. If these are functionally different project types, their descriptions should clarify the distinction or the use case for each.
Can you confirm whether these two types serve different purposes? If so, please update their descriptions to clarify when developers should select each option. For example:
react_native_web— React Native Web (web-only)react_native_and_rnw— React Native with Web support (monorepo/multi-target)
Or similar distinctions if that's not accurate.
---
🏁 Script executed:
```shell
#!/bin/bash
# Search for where these project types are defined in the codebase
rg -n "react_native_web|react_native_and_rnw" --type=ts --type=js --type=tsx --type=jsx -C3 | head -100
Length of output: 27
🏁 Script executed:
#!/bin/bash
# Look for enum or constant definitions containing these types
rg -n "enum|const.*Type|react_native" --type=ts --type=js -C2 | head -80Length of output: 4917
🏁 Script executed:
#!/bin/bash
# Search for any documentation files that might explain these types
fd -e md -e mdx -e txt | xargs rg -l "react_native_web\|react_native_and_rnw" 2>/dev/nullLength of output: 0
---
🏁 Script executed:
```shell
#!/bin/bash
# Search for ProjectTypeService or initializer that defines these types
rg -n "ProjectTypeService|initializeProject|react_native" | head -60
Length of output: 8108
🏁 Script executed:
#!/bin/bash
# Find files that might contain project type definitions or enums
fd . -type f -name "*.ts" -o -name "*.js" | xargs rg -l "angular.*ember.*html.*nextjs|ProjectType" 2>/dev/null | head -20Length of output: 1373
🏁 Script executed:
#!/bin/bash
# Search for any constant or variable that lists project framework types
rg -n "Framework|Type.*=" -A20 | grep -E "(react|angular|vue|svelte)" | head -80Length of output: 6275
---
🏁 Script executed:
```shell
#!/bin/bash
# Read the projectTypes.ts enum definition
cat code/core/src/cli/projectTypes.ts
Length of output: 589
🏁 Script executed:
#!/bin/bash
# Read the ProjectTypeService implementation
cat code/lib/create-storybook/src/services/ProjectTypeService.ts | head -200Length of output: 6989
🏁 Script executed:
#!/bin/bash
# Look for any comments or documentation about react_native types
rg -n "react_native_web|react_native_and_rnw" -B3 -A3 code/lib/create-storybook/src/services/Length of output: 0
---
🏁 Script executed:
```shell
#!/bin/bash
# Get the full ProjectTypeService to see if there are configs for these types
cat code/lib/create-storybook/src/services/ProjectTypeService.ts | tail -100
Length of output: 3110
🏁 Script executed:
#!/bin/bash
# Search for any usage documentation or comments about the distinction
rg -n "REACT_NATIVE" code/lib/create-storybook/src/ -B2 -A2 | head -80Length of output: 7599
Clarify the distinction between react_native_web and react_native_and_rnw project types (lines 182–183).
Both entries currently map to "React Native Web" but serve different purposes in the codebase. The react_native_web type configures a web-only setup, while react_native_and_rnw combines React Native and React Native Web generators for dual-target monorepo setups. Update the descriptions to reflect this distinction, for example:
react_native_web— React Native Web (web target)react_native_and_rnw— React Native and Web (dual targets)
🤖 Prompt for AI Agents
In docs/get-started/install.mdx around lines 169 to 191, the table entries for
`react_native_web` and `react_native_and_rnw` both say "React Native Web" but
mean different things; change the descriptions so `react_native_web` reads
something like "React Native Web (web target)" and `react_native_and_rnw` reads
"React Native and Web (dual targets)" to clearly convey that one is web-only and
the other sets up a combined React Native + React Native Web
dual-target/monorepo configuration.
valentinpalkovic
deleted the
valentin/edit-install-instruction-cli-flags
branch
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.