Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation and add documentation for elixir #81

Open
D4no0 opened this issue Jun 22, 2022 · 4 comments
Open

Fix documentation and add documentation for elixir #81

D4no0 opened this issue Jun 22, 2022 · 4 comments

Comments

@D4no0
Copy link
Contributor

D4no0 commented Jun 22, 2022

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
Copy link
Owner

Great!

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

@D4no0
Copy link
Contributor Author

D4no0 commented Jun 23, 2022

I've create a MR to fix documentation build: #82 . After this is merged I can add the scaffolding for hexdocs html documentation generation.

@D4no0
Copy link
Contributor Author

D4no0 commented Jun 26, 2022

I added scaffolding and configuration for generating documentation on HexDocs : #83

@D4no0
Copy link
Contributor Author

D4no0 commented Jun 26, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants