Documentation

Why is documentation important?

Without up-to-date guides and explanations about the modules and services that Expo provides, using them becomes quite a hassle. This means that to make the experience of using Expo as awesome as it can possibly be, clear and thorough documentation is one of our top priorities.

How are the docs laid out?

All our documentation source can be found in the docs/ directory. We maintain different version of our documentation, each pointing towards a specific SDK that we are currently supporting (usually this is about 3 or 4 different versions). The unversioned directory is the documentation for the master branch, meaning it has not been released yet. Any time you only want changes in the documentation to go into effect with the next SDK release, you should only make changes to the unversioned docs directory.

How can I help make the docs better?

There are two ways to make the documentation better:

• Open up a documentation issue and describe what you think could be better, and how. Make sure to be as clear and specific as you can.
• Contribute to our documentation! This is easy to do, and has a huge impact on the developer experience. You can edit files directly in the Github UI, or clone the repo and then edit the markdown files as you would any other code file.
  • If you're making changes to any of the currently released SDK docs directories, make sure you apply the same changes to the unversioned directory.
  • After cloning this repo, you can run a local version of our documentation site by going into the docs directory (cd docs), installing dependencies (yarn), and then running the app (yarn run dev). Now the documentation is running at http://localhost:3000