This is the working repository for our new docs effort. The infrastructure is built on SolidStart and the content structure and goals are inspired by Diataxis and the React Beta Docs.
Our Stackblitz or Gitpod or links are the quickest way to set up a development environment, which lets you browse and edit the project files and run the resulting site locally.
We use npm as our a package manager. If you clone this project locally, install npm, then run these commands to start the project:
npm install npm run dev(Contributing guide and writing guide in progress!)
- A product has users, and product teams design, engineer, and maintain solutions that serve them. We’re not writing text that describes SolidJS, we’re using everything at our disposal to teach SolidJS and make our users feel great about themselves throughout the learning process.
- The SolidJS user experience depends on the docs. The Docs Team cares about the entire onboarding and learning experience, which extends beyond written docs into examples, videos, and templates. SolidJS is not an independent project from its docs, and docs are a Core concern.
- The best docs are not written by the most experienced or entrenched user, they’re not written with one user in mind, and they’re not written alone. The Docs Team seeks to recruit contributors across a wide range of disciplines, perspectives, and experiences, and to foster an environment where every voice is heard.
- Language, disability, and background should not be a barrier to learning SolidJS. Any user that wants to learn or teach SolidJS must be able to, and docs can enable skills and experiences previously closed off to someone.
- It feels and should feel amazing to learn a new skill, and it should certainly feel great to teach it. We’re a community of volunteers, and that community matters: we care about our users, and we care about each other.