-
Notifications
You must be signed in to change notification settings - Fork 4
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
Update Docs and Re-publish #32
Comments
9 tasks
5 tasks
nelsonic
added a commit
that referenced
this issue
Dec 18, 2019
nelsonic
added a commit
to dwyl/elixir-auth-github-demo
that referenced
this issue
Dec 18, 2019
nelsonic
added a commit
that referenced
this issue
Dec 18, 2019
nelsonic
added a commit
that referenced
this issue
Dec 18, 2019
nelsonic
added a commit
that referenced
this issue
Dec 26, 2019
nelsonic
added a commit
that referenced
this issue
Dec 28, 2019
nelsonic
added a commit
that referenced
this issue
Dec 28, 2019
nelsonic
added a commit
that referenced
this issue
Dec 29, 2019
nelsonic
added a commit
that referenced
this issue
Feb 1, 2020
nelsonic
added a commit
that referenced
this issue
Feb 1, 2020
nelsonic
added a commit
that referenced
this issue
Feb 1, 2020
nelsonic
added a commit
that referenced
this issue
Feb 1, 2020
nelsonic
added a commit
that referenced
this issue
Feb 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
code
in this package/repo works. β πBut there is nowhere near enough documentation for someone
else
to use the package without reading the code in/lib
... as a result only we (@dwyl) are using it and nobodyelse
is benefiting from it.We need to comprehensively document the package (a) because it makes it easier to maintain, (b) it makes it easier (possible) for other people to use it and get their GitHub Auth enabled projects off the ground and (c) other people in the elixir/dwyl community can contribute improvements.
Similar to dwyl/elixir-auth-google#10 and PR: dwyl/elixir-auth-google#11
Thankfully this package's /lib/elixir_auth_github.ex already has pretty decent
@doc
comments πSo all that is missing is are the detailed instructions for getting it setup.
Compare the difference:
before
: https://github.com/dwyl/elixir-auth-google/tree/2b1f9b09433fb7845dff00f593edd8fa29825f5fafter
: https://github.com/dwyl/elixir-auth-google/tree/71c022afee27e2cc377936c686538afa8e08d13eTodo
demo
app similar to https://github.com/dwyl/elixir-auth-google-demoREADME.md
with comprehensive instructions for addingelixir-auth-github
to a sample Phoenix App.hex.pm
packagebefore
: https://github.com/dwyl/elixir-auth-github/tree/44021233add025348f261f5bf0b9b32fe6c5711aafter
: π https://github.com/dwyl/elixir-auth-github/tree/update-docs-issue%2332The text was updated successfully, but these errors were encountered: