-
Notifications
You must be signed in to change notification settings - Fork 331
feat: describe jsx transpilation #1069
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
Conversation
Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
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.
This contains a lot of valuable information about how Solid works. Nice job. However, I'm uncertain if it aligns well with our docs. Even in the advanced section, I think it's too technical to be useful to most people.
The section on Hyperscript is helpful for those who want to use Solid without a build step (there's an issue regarding this), but I would prefer to have a more practical guide about it.
If we had a blog, I would share this information there, as it would be a shame to lose it. Especially the information about custom renderers is interesting. Overall, I don't think this is a good fit for our docs.
What do we want to do with this pr?
Needs to be reviewed still. I haven't had the time and other people haven't been available to @brenelz
I still don’t think this content is a good fit for our docs. The topics covered here feel way too advanced for most users. Unless someone is really interested in building a framework or digging deep into Solid, this page might just confuse them.
So, I suggest we close this PR and move the useful points (for average users) to other sections:
I really believe we should not leave these parts undocumented. I'll happily add a warning that these are advanced topics that are not required knowledge to use solid.js, but I am against leaving out content that might help advanced readers.
Meeting beginners is fine, ignoring advanced users is not.
Description(required)
The current docs are missing information on how solid works under the hood, especially the JSX transpilation. I aim to fill this gap with the current PR
Related issues & labels
./.