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.

Sign up for GitHub

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

Jump to bottom

Extract documentation from README.md #37

Closed
2 tasks
lcobucci opened this issue Sep 11, 2015 · 7 comments
Closed
2 tasks

Extract documentation from README.md #37

lcobucci opened this issue Sep 11, 2015 · 7 comments
Labels
Documentation
Milestone
4.0.0-beta1

Comments

@lcobucci
Copy link
Owner

In order to improve the readability of the documentation let's split it into multiple files under doc folder.

  • Provide some introduction about claims
  • Provide some examples on what goes on server and client sides
@lcobucci lcobucci added this to the 4.0.0 milestone Sep 11, 2015
@delatbabel
Copy link

What would help, I think, is to separate the documentation into what needs to be done on the client side and what needs to be done on the server side. At the moment I'm trying to write a REST API client and server and it's not clear at first what needs to be done on the client and what needs to be done on the server.

@iannsp
Copy link

iannsp commented Jan 27, 2016

👍

@lcobucci
Copy link
Owner Author

That's a good idea @delatbabel, can you send a PR with your experience and we may improve it together?

@delatbabel
Copy link

Will do. I'm in the middle of some other major work at the moment but I'll get onto it in the next couple of weeks.

@lcobucci
Copy link
Owner Author

lcobucci commented Feb 1, 2016

No problem @delatbabel 😄 thanks!

@lcobucci lcobucci mentioned this issue Aug 31, 2016
Closed
@lcobucci lcobucci mentioned this issue Nov 24, 2016
Closed
@lcobucci lcobucci mentioned this issue Jan 10, 2017
Closed
@schnittstabil
Copy link

Related: Publishing with GitHub Pages, now as easy as 1, 2, 3 (December 9, 2016)

ricardoseriani added a commit to ricardoseriani/jwt that referenced this issue May 29, 2017
@ricardoseriani
Fix README.md linking to issue lcobucci#37
de8bf19 
Fix README.md linking to issue lcobucci#37
ricardoseriani added a commit to ricardoseriani/jwt that referenced this issue May 29, 2017
@ricardoseriani
Fix README.md linking to issue lcobucci#37
15a034c
@ricardoseriani ricardoseriani mentioned this issue May 29, 2017
Merged
Ocramius added a commit that referenced this issue May 29, 2017
@Ocramius
Merge pull request #184 from ricardoseriani/Fix-README.md-linking-to-…
010662c 
…issue-#37

 Fix README.md link to issue #37
@lcobucci lcobucci removed this from the 4.0.0-alpha1 milestone Feb 27, 2019
lcobucci added a commit that referenced this issue Oct 12, 2019
@lcobucci
Document library
5109954 
Allowing us to properly render things using https://readthedocs.org.

Fixes:

 - #37
 - #94
 - #219
@lcobucci lcobucci added this to the 4.0.0-alpha4 milestone Oct 12, 2019
@lcobucci
Copy link
Owner Author

Documentation added in #326

Horikawaer added a commit to Horikawaer/jwt that referenced this issue Nov 3, 2022
@Horikawaer @lcobucci
Document library
d06e444 
Allowing us to properly render things using https://readthedocs.org.

Fixes:

 - lcobucci/jwt#37
 - lcobucci/jwt#94
 - lcobucci/jwt#219
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
4.0.0-beta1
Development

No branches or pull requests
4 participants
@iannsp @lcobucci @delatbabel @schnittstabil