Add documentation generator

stroeer / tapir

T-online API Repository

https://stroeer.github.io/tapir/article.html

Apache License 2.0

5 stars 8 forks source link

Add documentation generator #84

Closed bobaaaaa closed 2 years ago

bobaaaaa commented 4 years ago

At some point we need some documentation for some code conventions. Examples:

list of valid BodyNode.type strings
list of valid fields keys

Requirements

generate HTML documentation based on code comments
deploy & host to GitHub pages (latest published version)

Links

https://github.com/pseudomuto/protoc-gen-doc

Future

How do we deal with API changes? Versioned documentation?

moritzzimmer commented 3 years ago

We (@thisismana, @bobaaaaa, @harryurban and @moritzzimmer) agreed to first invest time in documenting our proto messages and gRPC APIs. Generating a HTML documentation in addition to the documented proto files might follow later.