Specificity in Documentation and Clear Code Snippets #10162
WalterOkumu
started this conversation in
Proposals
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hi Remix Team,
First off, thank you for the incredible work on Remix! I truly appreciate the effort that goes into the documentation.
My journey has been React JS -> Next JS and now Remix JS, and I absolutely have loved it. While migrating from each has been a challenge, documentation has really been a cornerstone in helping me deliver on what the project requires and adjust based on the new framework. Unfortunately, with Remix, I have had to rely on AI Coding to bridge the gap in documentation, which is a positive and negative at the same time.
I wanted to provide some feedback regarding the code snippets in the examples. I’ve noticed that many of the snippets lack specific details, such as the necessary package imports. As a newcomer to Remix, I often find myself making assumptions or going through trial and error to figure out what I need to import, which can be quite challenging.
Including complete examples with all relevant imports would greatly enhance the clarity and usability of the documentation. This small change could make a significant difference for those just starting out.
Thank you for considering this suggestion, and keep up the great work!
Beta Was this translation helpful? Give feedback.
All reactions