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

documentation and typespec #34

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

boonious
Copy link
Contributor

@boonious boonious commented Sep 21, 2020

Provide documentation and typespecs in all modules to enable publication to Hex and HexDocs.

To generate and view documentation locally run:

mix docs

@boonious boonious force-pushed the documentation-typespec branch from 2431f92 to 98d04f0 Compare October 2, 2020 07:59
@astalker
Copy link
Contributor

astalker commented Oct 2, 2020

Shall we add some docs to the readme (nothing more than a quick note really) to mention how to build the docs?

Also, should be we tag the release too in git or is that not really required when we use hex?

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

Successfully merging this pull request may close these issues.

2 participants