Somehow auto-generate documentation (i.e. website) from `*.proto` files

[achaphiv]

What

Generate a developer documentation site.

We previously used swagger. Ideally this site would be something like that or better.

Basic swagger example: https://petstore.swagger.io/ Basic protoc-gen-doc example: https://rawgit.com/pseudomuto/protoc-gen-doc/master/examples/doc/example.html Basic sabledocs example: https://markvincze.github.io/sabledocs/demo/ Advanced custom example: https://docs.stripe.com/

TODO

Somehow generate *.html or *.json metadata from the *.proto files.

E.G.

• https://github.com/pseudomuto/protoc-gen-doc
• https://github.com/markvincze/sabledocs

Use (maybe?) a static site generator like astro.

Host on one of:

• github pages
• cloudflare
• vercel

[achaphiv]

I started pushing *.proto files to:

https://buf.build/mtprm/mtprm-proto

It's working as of: 6a3cf08be8cc794c652e39be876d4392e6cdb41d

Apparently, buf.build auto-generates client/server stub code.

So that potentially avoids the need to do this ourselves.