search

tsloughter / grpcbox

Erlang grpc on chatterbox
Apache License 2.0
138 stars 61 forks source link

Fix documentation and add documentation for elixir #81

Open D4no0 opened 2 years ago

D4no0 commented 2 years ago

I would like to make a MR, where I will fix the documentation build, add possibility for documentation to be built for HexDocs just like telemetry, and finally try to complete all the missing documentation.

What I need to know is how _bhvr files were generated and why they contain the invalid @doc tags?

tsloughter commented 2 years ago

Great!

The files are generated by the plugin based on templates in its repo https://github.com/tsloughter/grpcbox_plugin/tree/master/priv

D4no0 commented 2 years ago

I've create a MR to fix documentation build: https://github.com/tsloughter/grpcbox/pull/82 . After this is merged I can add the scaffolding for hexdocs html documentation generation.

D4no0 commented 2 years ago

I added scaffolding and configuration for generating documentation on HexDocs : https://github.com/tsloughter/grpcbox/pull/83

D4no0 commented 2 years ago

At this point, after merging these 2 PR's, you should be able to build/publish the documentation of the project to HexDocs. The next step would be to make examples, document functionality for both elixir and erlang.