-
Notifications
You must be signed in to change notification settings - Fork 217
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add stormkit as deployment option #700
Conversation
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Hello @eldemcan 👋 Thank you for your pull request! We are happy to add Stormkit to the docs! Before proceeding to review the PR, I would ask you first to check our Writing guide and make sure everything in your pull request respects it. Thank you for your contribution and time 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, @eldemcan , thank you for this PR.
As @danieljcafonso mentioned above, there are a few things that need to be done to adhere to the Writing Guides. We'd love to have Stormkit as another deploy option for our users, but please, take a good look at our guides.
Example:
- not "SolidJs", but "Solid" is fine. (We use SolidJS (with JS capitalized) if it's important to disambiguate based on context, not the case here)
- Use code markup for comands, e.g.:
npm run build
instead of npm run build
And please, when convenient to the reader, explain the process in enough details they would be confident in doing it. That's preferrable than sending users in a link hunt across different docs. Sometimes it's overwhelming to add all information, in those cases, please: add links to the appropriate sections in your own documentation.
Cheers. 😊
@atilafassina @danieljcafonso thanks for your guidence and links. I updated documentation. What I put here will be sufficent enough for Solid users to hit the ground and running. |
fb70526
to
3e59747
Compare
Adding Stormkit as deployment option