🤔 Documentation for the documentation. How do you contribute to the documentation?
mkdocs-material, see their cool instructions.
For GraphQL documentation, the playground generates the documentation for us automatically.
📝 Writing documentation is simple with MkDocs.
- Open up the project, and navigate to the
- Make your changes to the markdown (
.md) files within this folder.
- Create a pull request to
master. Once your pull request is merged with
master, the documentation site will be automatically rebuilt.
How is the docs site updated?
All documentation site files are built to
The docs are run through a CI pipeline through CircleCI, that will automatically build the documentation into the
/docs-site folder. This build is run through a command by the MkDocs python package.
✨ Make your documentation user-friendly.
👀 Preview your changes live.
Preview your changes with
mkdocs serve, and see the generated documentation locally with
mkdocs build -d docs-site.
Configure documentation site settings in