Docs Generation

How to create docs for your GraphQL Schema

To create docs for your project your schema should have at least a root Query object.

To deploy docs:

1. Deploy Mock Backend
2. Open Schema Documentation
3. You can browse docs

Browsing docs

All descriptions inside a schema are rendered with a remark markdown engine. After clicking a type inside the Table of Contents the interface should scroll down to that field. If you click on the type inside a field it will navigate you to the page containing the documentation of the clicked type.

‚Äč