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

Clean readme & move doc #1129

Merged
merged 5 commits into from
Apr 3, 2018

Conversation

MaicolBen
Copy link
Collaborator

@MaicolBen MaicolBen commented Mar 30, 2018

Summary

The idea of this PR is cleaning the long and confusing README, and move a lot of information to a doc section. The docs can be accessed through gitbook, you can search and see the information organized in pages there.

Also, I moved the wiki to the docs as FAQ, so can review the doc changes through PR requests and it's in one place, so the wiki will disappear.

Preview

Issues resolved

Resolves #1114
Resolves #745
Resolves #604
Resolves #75
Resolves #1069

About #604, I tried to cover all the questions/doubts in the existing wiki, there is an alternative flow asked there, that #1072 will cover.
About #75, it's covered in the "Testing with Rspec" section

Notes:

@zachfeldman
Copy link
Contributor

This is amazing @MaicolBen !

@dks17
Copy link
Contributor

dks17 commented Mar 30, 2018

omniauth.md
Is the link of demo app correct?

For example, the demo app uses the default omniauth_prefix setting /omniauth, so the "Authorization callback URL" for github must be set to "http://devise-token-auth-demo.herokuapp.com**/omniauth**/github/callback".

The demo app looks not working. Is it OK?

@MaicolBen
Copy link
Collaborator Author

@dks17 @lynndylanhurley That's an example, isn't it?

Also, the Angular 2 demo is down, should I remove the link? Or open a new ticket for it?

@dks17
Copy link
Contributor

dks17 commented Apr 1, 2018

@MaicolBen I don't know whose the demo this is.
I created issue Live demo is not working.

@zachfeldman
Copy link
Contributor

@MaicolBen I think we should merge this, then file further issues for other outstanding README problems (like possibly non-working demos). Sound good?

@MaicolBen
Copy link
Collaborator Author

Sounds good! I think we need @lynndylanhurley's approval, and we are good to go

Change links to https protocol
Copy link
Owner

@lynndylanhurley lynndylanhurley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @MaicolBen!!

@zachfeldman zachfeldman merged commit 23ed467 into lynndylanhurley:master Apr 3, 2018
@neroniaky
Copy link
Contributor

@dks17 I updated the demo to use stackblitz: https://stackblitz.com/github/neroniaky/angular-token
Gonna see how it works and create a PR later.

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