solid-docs
solid-docs copied to clipboard
solidjs
Target Audience
I'd love to start jumping in and improving the documentation, especially the tutorial, which is an incredible accomplishment so far but can benefit from some changes (mainly streamlining to make it less wordy and to assume less knowledge on the reader).
Along those lines, I can't seem to find any documentation here on the intent of each part of the docs. The main parts seem to be Getting Started, Tutorial, and the full Documentation. It's the former two that I think it would be really helpful to have clarity on as we move forward.
What is the relationship between the Getting Started guide and the Tutorial? It's clear that the Tutorial is more comprehensive, and the Getting Started guide is more of an overview. However, it would help to write out the goals of each. For what it's worth, my initial take is that the Getting Started guide should be the initial stop for someone who knows other reactive frameworks and wants to learn Solid, while the Tutorial should be an in-depth guide for a complete beginner who wants to go from zero to hero with Solid.
Along those lines, I think the tutorial should be as accessible as possible. There's no egregious problem with it or anything, but it does sometime assume knowledge of terminology or predecessor concepts. (A good example is the "What is Solid" description on the first introductory lesson). I'd love to help improve that; determining the goals for the Tutorial will help contributors to be aligned as we work on it.
This is a great question. My opinion is this is far too early to translate the new docs since they're going to change a lot over the coming months. They will absolutely need translation eventually though, we're just not there yet.
@Jutanium what are your thoughts?
Exactly as @nas5w said - we absolutely will need translators but it's too early. As for what to do now: the Feature Tutorial and API Docs will remain largely the same from the old site to the new site, so these are perfect to focus on in the meantime :)