FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat: describe jsx transpilation by atk · Pull Request #1069 · solidjs/solid-docs · GitHub

feat: describe jsx transpilation - #1069

Open
atk wants to merge 37 commits into
solidjs:mainfrom
atk:feat/how-it-works
Open

feat: describe jsx transpilation#1069
atk wants to merge 37 commits into
solidjs:mainfrom
atk:feat/how-it-works

Conversation

atk commented Feb 11, 2025

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

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

./.

Copy link
Copy Markdown

Run & review this pull request in StackBlitz Codeflow.

netlify Bot commented Feb 11, 2025
edited
Loading

Copy link
Copy Markdown

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit a4081c2
🔍 Latest deploy log https://app.netlify.com/sites/solid-docs/deploys/67d72f07598bbf00084b0660
😎 Deploy Preview https://deploy-preview-1069--solid-docs.netlify.app
📱 Preview on mobile Toggle QR Code...



Use your smartphone camera to open QR code link.

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

amirhhashemi left a comment
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

brenelz commented Aug 1, 2025

Copy link
Copy Markdown
Collaborator

What do we want to do with this pr?

Copy link
Copy Markdown
Member

Needs to be reviewed still. I haven't had the time and other people haven't been available to @brenelz

amirhhashemi commented Aug 2, 2025
edited
Loading

Copy link
Copy Markdown
Collaborator

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 noticed the createRenderer function isn’t documented yet. Tracked here.
  • After Solid 2.0, we should definitely document Hyperscript functions. Tracked here.

atk commented Aug 3, 2025

Copy link
Copy Markdown
Contributor Author

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.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

4 participants


Back | FazBrowse Home | New Git URL