While there is a lot of Solid documentation out there, and resources like forums and chat rooms for getting started, we've found that it can be difficult--for an interested user or developer or engineer--to know where to jump in, or perhaps even what to start learning first. We aim to create a comprehensive and user-friendly guide to getting started with Solid--whether registering and using a Pod, developing apps, hosting a server (Pod provider), or contributing to the project. We will do this by: 1) organizing links to existing documentation, 2) creating interactive guides to documentation based on interests and needs, and 3) creating new documentation employing techniques designed for different learning styles and use cases.
All are welcome to participate! We invite input, feedback, questions and contributions from beginners to experienced Solid users. If you're interested in using Solid, or building Solid apps, or hosting one or more Solid servers, please join us to help introduce new members to Solid. We have adopted the Contributor Covenant, which you can read in our CODE OF CONDUCT file.
We plan to use Github's built-in tools for creating issues, adding comments, etc., but for now, if you have a question or comment, or would like a tip on how to start contributing, please send an email to: [email protected]
This repository will be hosted as a Github page (for now, at least), and in its first iteration, will likely be a collection of links to documentation, protocols, and app examples. From there we hope to grow it into a more interactive, comprehensive, user-friendly guide to getting started with Solid. Depending on the limitations of Github pages, we may host it elsewhere eventually.
The idea for this system of organizing a guide to documentation based on its purpose, originally came from the Diataxis framework, which categorizes documentation as four types: tutorials, how-to guides, explanation, and reference. Further, it explains when these different types are most useful to a user, based on their immediate goals.
In addition to the above, we've also noticed (and read a little about) how different presentation tools and techniques can be honed to different types of learners, and different types of material.
Our goal is ambitious, but we plan to start simply (with a list of links), and build step by step, combining and implementing the above insights into a system that, we hope, will eventually offer a comprehensive and user-friendly guide to Solid that is tailored to each person's needs and interests.
We believe it will be worth the effort, and hope you will join us!