Create custom non-GraphQL documentation

[naftis]

We have a couple of endpoints like the OAuth-compliant /token -endpoint, which is an REST API. I want to document this stuff to the same docs to keep it understandable for the API user. What is the recommended way to do this, or should I look into other solutions?

[newhouse]

Hello @naftis and thanks for using SpectaQL!

The quick/dirty way would be to add a few "intro items" to your config:
https://github.com/anvilco/spectaql/blob/main/config-example.yml#L439

This may be fine, but you will only be able to have content render in the main/center column, and not out in the examples area.

If you want more control, you'll probably need to make a simple "custom theme" that overrides the view templates that you're interested in controlling/modifying. It's not too hard to do to make simple modifications:
https://github.com/anvilco/spectaql/blob/main/examples/themes/README.md

Hopefully one of those 2 options will work for you!