/solid-docs-next

Solid Docs, rehauled. Very much in progress

Primary LanguageTypeScript

Solid Docs

Tests

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.

Running the Site

Our Stackblitz or Gitpod 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

(Contributing guide and writing guide in progress!)

The Solid Docs Manifesto

  1. Documentation is a product.

    A product has users, and product teams design, engineer, and maintain solutions that serve them. We’re not writing text that describes Solid, we’re using everything at our disposal to teach Solid and empower our users throughout their learning process.

  2. Documentation is the product.

    Solid's user experience depends on the docs. Solid is not an independent project from its docs, and docs are a core concern for the Solid team. We care about the entire onboarding and learning experience, from your first time installing the library to your first dive into Solid's source code.

  3. Documentation is inclusive and collaborative.

    We prioritize inclusion because good design is inclusive. Everyone should be able to understand the docs, and everyone should feel that the docs are written by people like them for people like them. This includes people of different perspectives, backgrounds, and levels of tech expertise.

  4. Documentation is accessible.

    Learning Solid should be possible for anyone. At their best, docs break down barriers and create new opportunities. To do that, we must accomodate all learners. Beyond accessible text, docs include code examples, videos, and drawings, so we can support different needs and learning styles.

  5. Documentation is fun.

    Learning a new skill feels amazing. Let’s make it fun to teach, too! We’re a community of volunteers, and that community matters: we care about our users, and we care about each other.