docs: use svelte cli instead of create-svelte and svelte-add #1502
Conversation
|
@0ranga is attempting to deploy a commit to the Themesberg Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe pull request updates the documentation for SvelteKit and Flowbite Svelte installation instructions across two markdown files. The primary changes involve modifying command-line instructions for project creation and dependency installation, with a focus on simplifying the setup process. The updates standardize the commands from npm-based syntax to a new Changes
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
src/routes/icons/svelte-4.md (1)
Line range hint
1-7: Resolve version inconsistency in documentation.The page title indicates "Svelte 4 Icons" but the description mentions "Svelte 5". This might confuse users about version compatibility.
-description: Get started with a collection of open-source Svelte 5 powered icons built by the Flowbite community and based on the official design +description: Get started with a collection of open-source Svelte 4 powered icons built by the Flowbite community and based on the official design
🧹 Nitpick comments (3)
src/routes/docs/pages/quickstart.md (1)
26-28: Ensure project name consistency across documentation.The project name
my-appis used here, but other documentation files usemy-project. Let's maintain consistency across all files.-npx sv create my-app +npx sv create my-project cd my-app pnpm installsrc/routes/docs/pages/introduction.md (1)
27-29: Ensure project name consistency across documentation.The project name
my-appis used here, but other documentation files usemy-project. Let's maintain consistency across all files.-npx sv create my-app +npx sv create my-project cd my-app pnpm installsrc/routes/icons/svelte-4.md (1)
38-41: Ensure project name consistency and fix directory change command.The project name and directory change command need to be consistent with other documentation files.
-npx sv create my-app -cd my-project +npx sv create my-project +cd my-project npx sv add tailwindcss pnpm i
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/routes/docs/pages/introduction.md(2 hunks)src/routes/docs/pages/quickstart.md(2 hunks)src/routes/icons/svelte-4.md(1 hunks)
🔇 Additional comments (2)
src/routes/docs/pages/quickstart.md (1)
46-48: LGTM! Command updated correctly.
The Tailwind CSS installation command has been correctly updated to use the new Svelte CLI syntax.
src/routes/docs/pages/introduction.md (1)
47-48: LGTM! Command updated correctly.
The Tailwind CSS installation command has been correctly updated to use the new Svelte CLI syntax.
gemb0y
force-pushed
the
update_docs_to_use_svelte_cli
branch
from
243b0fa to
06b1036
Compare
With version 5 of svelte, svelte-add and create-svelte commands are deprecated. Svelte cli is the new way to go so the docs have been updated to replace: - npm create svelte@latest my-project by npx sv create my-project - npx svelte-add@latest tailwindcss by npx sv add tailwindcss
gemb0y
force-pushed
the
update_docs_to_use_svelte_cli
branch
from
06b1036 to
ca67a89
Compare
📑 Description
With version 5 of svelte, svelte-add and create-svelte commands are deprecated. Svelte cli is the new way to go so the docs have been updated to replace:
Note
I did not change the commands in
src/routes/icons/svelte-4.mdsince it specifically talks about svelte 4 iconsStatus
✅ Checks
My pull request adheres to the code style of this projectMy code requires changes to the documentationI have checked the page with https://validator.unl.edu/All the tests have passedℹ Additional Information
Summary by CodeRabbit
New Features
Documentation