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

refactor (docs): Improve documentation #151

Merged
merged 2 commits into from
Nov 20, 2021
Merged

refactor (docs): Improve documentation #151

merged 2 commits into from
Nov 20, 2021

Conversation

darkgl0w
Copy link
Contributor

@darkgl0w darkgl0w commented Nov 20, 2021 •
edited
Loading

Hello.

This PR aims to improve the documentation of fast-jwt by:

  • properly documenting options and with direct RFC reference links (all relevant JWT related documentation accessible from one place),
  • some sentence rephrasing,
  • some formatting to enhance the reading experience (adding some white space between the options listing makes it easy to focus on the wanted information).

simoneb
simoneb approved these changes Nov 20, 2021
View reviewed changes
Copy link
Member

@simoneb simoneb left a comment

Choose a reason for hiding this comment

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

Wow this is awesome 🚀

mcollina
mcollina approved these changes Nov 20, 2021
View reviewed changes
Copy link
Contributor

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

Good work! LGTM

@ShogunPanda
Copy link
Contributor

Amazing! LGTM!

@mcollina mcollina merged commit cbd78c4 into nearform:master Nov 20, 2021
@darkgl0w darkgl0w deleted the improve-documentation branch November 20, 2021 14:45
@github-actions github-actions bot mentioned this pull request Nov 24, 2021
Closed
This was referenced Dec 1, 2021
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simoneb simoneb simoneb approved these changes

@mcollina mcollina mcollina approved these changes

@ShogunPanda ShogunPanda ShogunPanda approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@darkgl0w @ShogunPanda @simoneb @mcollina