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

Upload Docs to hexdocs #85

Open
jalcine opened this issue Oct 27, 2017 · 1 comment
Open

Upload Docs to hexdocs #85

jalcine opened this issue Oct 27, 2017 · 1 comment

Comments

@jalcine
Copy link
Member

jalcine commented Oct 27, 2017

Leveraging the community's own documentation system gives us a few things:

  • Better local documentation support with tools like Dash and Zeal,
  • Automatically generated documentation on new releases.
  • Easier discovery for users when looking for documentation at specific versions.
@jalcine
Copy link
Member Author

jalcine commented Jul 16, 2018

I noticed that there is some documentation at hedocs now!

https://hexdocs.pm/maru/readme.html

Though not comprehensive, it's an excellent start.

Would it be cool if some of the pages from https://maru.readme.io/docs were folded into the module docs to have those pages fleshed out there? This gives us the benefit of adding better version links to documentation on hex.pm

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