Yes, this is mostly already taken care of in the content plan for the new docs. For example, we’re trying to use less technical terms for page titles. So, instead of “templating” or “binding”, or something that is a framework-specific term, you’ll have an article named “Displaying Basic Data” or “Working with Collections”. Each article will also have a description, keyword metadata, etc. combined with full-text search, which will all feed into the docs search engine. Beyond that, most articles will have a “next” button at the bottom, pointing you to an article that follows the current topic, and many will have a “related” section for related articles both on the site and for relevant web standards. Furthermore, there is an entire area of the docs that is completely focused on code samples for common problems. These will be designed to “copy/paste” into your own solution, as much as we can make them. We’ve got ideas for what to put there and that will also grow extensively over time based on all of your input (and contributions
).
I should also mention that we’re re-organizing the content a lot and adding a lot of new content. With Aurelia 1, even if a topic was extensively covered, the information was often spread out over many articles. We’re moving related content closer together and trying to create something that’s more coherent. To help us with this, we’ve hired a professional technical writer to review our plans, articles, etc. and help us produce the best content we can.
Hopefully the combination of all these factors in the new docs will make Aurelia much easier to not only learn, but for experienced devs as well to quickly reference or find an example of what they are trying to do.