phero-hq / phero

Full-stack type-safety with pure TypeScript

Home Page:https://phero.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation autogeneration suggestion

liegeandlief opened this issue · comments

Phero is amazing when using the generated server and client together. But when building a backend which can be consumed by many clients, some of which may not be using TypeScript or even JavaScript, it would be really helpful to have documentation for each of the services.

If documentation could be autogenerated when the server is built then other developers using alternative clients could use this documentation to manually build their RPC requests.

Thanks again for all your hard work on this brilliant project!

Wow, thank you very much for your kind words 🙏 And awesome suggestion.

Auto-generating docs (for function-signatures and combining them with the notes above them) is something we did already talk about internally, as well as making these functions a bit more easily accessible with regular/classic http-clients. Keep you posted!