chore: rollback docs due to sonatype disaster (#581)

This commit is contained in:
Ryan Brink
2024-03-06 10:16:00 -05:00
committed by GitHub
parent 889fdb41d7
commit dcde50de0a
6 changed files with 140 additions and 131 deletions

View File

@ -1,6 +1,20 @@
The Playground is a module inside the Kompendium repository that provides out of the box examples for a variety of
Kompendium features.
You can find all the playground
At the moment, the following playground applications are
| Example | Description |
|--------------|------------------------------------------------------------|
| Basic | A minimally viable Kompendium application |
| Auth | Documenting authenticated routes |
| Custom Types | Documenting custom scalars to be used by Kompendium |
| Exceptions | Documenting exception responses |
| Gson | Serialization using Gson instead of the default Kotlinx |
| Hidden Docs | Place your generated documentation behind authorization |
| Jackson | Serialization using Jackson instead of the default KotlinX |
| Locations | Using the Ktor Locations API to define routes |
| Resources | Using the Ktor Resources API to define routes |
You can find all of the playground
examples [here](https://github.com/bkbnio/kompendium/tree/main/playground/src/main/kotlin/io/bkbn/kompendium/playground)
in the Kompendium repository