Skip to content

Improve Solid quick start#1178

Merged
LadyBluenotes merged 9 commits intosolidjs:mainfrom
amirhhashemi:improve-quick-start
May 30, 2025
Merged

Improve Solid quick start#1178
LadyBluenotes merged 9 commits intosolidjs:mainfrom
amirhhashemi:improve-quick-start

Conversation

@amirhhashemi
Copy link
Copy Markdown
Collaborator

  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

This PR improves the "quick start" page for Solid.js:

  1. It recommends using the new Solid CLI instead of the old degit command. The new CLI is more beginner-friendly and offers additional features. Plus, the term "degit" might be confusing for new users.
  2. It moves the section about the Solid Playground to the end of the page. Since the playground is not typically a way to start a project, I believe most users prefer to start a project locally. However, I'm open to feedback regarding this change.

Related issues & labels

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2025

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 5a89388
🔍 Latest deploy log https://app.netlify.com/sites/solid-docs/deploys/6821b6d974981400088c12eb
😎 Deploy Preview https://deploy-preview-1178--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2025

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 75c8d96
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/683940fe9e3ae80007493344
😎 Deploy Preview https://deploy-preview-1178--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread src/routes/quick-start.mdx Outdated
Comment thread src/routes/quick-start.mdx
@LadyBluenotes LadyBluenotes enabled auto-merge (squash) May 26, 2025 23:17
@LadyBluenotes LadyBluenotes disabled auto-merge May 26, 2025 23:19
@klequis
Copy link
Copy Markdown
Contributor

klequis commented May 27, 2025

current: "An updated Node.js or Deno installation."

proposed: "A recent version of Node.js or Deno installed."

  • you need Node or Deno 18.x or above but I assume putting the version number here in the doc is just another maintenance task.
  • "updated" is less accurate than "recent"

Additionally: I use fnm (fast node manager) and when I create a new project I get a cryptic error message because I don't have a version of node specified for the project. I wouldn't be surprised if having a version below the minimum gave a cryptic message as well. I'm wondering if we can't help the reader a bit more.

I think the required node version is in the README of all the templates.It is >=18.x - I think. Could we direct the user there?

  • I don't remember seeing the required node version anywhere in the docs but if already there that would be better.

BTW @amirhhashemi, it is really easy to nit pick other people's work so please know I like your contributions to solid-docs!

@amirhhashemi
Copy link
Copy Markdown
Collaborator Author

amirhhashemi commented May 27, 2025

current: "An updated Node.js or Deno installation."
proposed: "A recent version of Node.js or Deno installed."

I agree.

I think the required node version is in the README of all the templates.It is >=18.x - I think. Could we direct the user there?

I couldn't find specific information either. If the minimum required version is indeed 18.x, it's worth noting that it has recently reached its end-of-life. Therefore, any recent version should be sufficient. Vite requires version 16 or higher, and Nitro recommends the latest LTS version.

We support three runtimes: Node, Bun, and Deno. Keeping all of them updated could be a maintenance burden. Until we have accurate information, I think recommending the latest LTS version is a reasonable approach.

If an outdated version is installed, users will likely encounter an error from the package manager or Node version manager.

@klequis

@LadyBluenotes LadyBluenotes merged commit 2a2d8b2 into solidjs:main May 30, 2025
3 checks passed
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.

[Content]:Replace degit into tiged to help people using https_proxy.

3 participants