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

Use ExDoc #107

Open
xxdavid opened this issue Oct 7, 2022 · 0 comments
Open

Use ExDoc #107

xxdavid opened this issue Oct 7, 2022 · 0 comments

Comments

@xxdavid
Copy link
Contributor

xxdavid commented Oct 7, 2022

The documentation of brod is much nicer now when you use ExDoc (I love it!). I think it would be great if kafka_protocol used it as well.

Aside from UI/UX, it would make links (particularly for types) from brod's documentation to kafka_protocol's one to work better. ExDoc uses a different format of anchors than EDoc does, so for example the link https://hexdocs.pm/kafka_protocol/kpro.html#t:connection/0 opens the page at the top and does not jump to directly to the connection/0 type so one has to find it manually.

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

1 participant