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

Added a Table of Contents to the README #338

Merged
merged 4 commits into from
Jan 20, 2020
Merged

Added a Table of Contents to the README #338

merged 4 commits into from
Jan 20, 2020

Conversation

Widcket
Copy link
Contributor

@Widcket Widcket commented Jan 16, 2020 •
edited

Changes

  • Added a Table of Contents to the README.
  • Placed the Important Notice section above it.
  • Replaced "Hosted Login Page" references with "Universal Login".
  • Ensured consistent title casing.
  • Updated links.
  • Ensured consistent punctuation.

Checklist

@Widcket Widcket added documentation This adds, fixes or improves documentation CH: Changed small labels Jan 16, 2020
@Widcket Widcket added this to the vNext milestone Jan 16, 2020
@Widcket Widcket requested a review from a team January 16, 2020 21:47
stevehobbsdev
stevehobbsdev requested changes Jan 17, 2020
View reviewed changes
Copy link

@stevehobbsdev stevehobbsdev left a comment

Choose a reason for hiding this comment

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

Generally fine, just a couple tweaks and places where we can link off to help the reader.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
lbalmaceda
lbalmaceda reviewed Jan 17, 2020
View reviewed changes
Copy link
Contributor

@lbalmaceda lbalmaceda left a comment

Choose a reason for hiding this comment

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

From my phone now. But make sure every link on the readme work, as it might be referring to outdated articles. Also, check the table links as well.

Widcket and others added 2 commits January 17, 2020 09:00
@Widcket
Update README.md
1c9d5e8 
Co-Authored-By: Steve Hobbs <steve.hobbs.mail@gmail.com>
@Widcket
Address requested changes
aacf3ce
lbalmaceda
lbalmaceda previously approved these changes Jan 17, 2020
View reviewed changes
Copy link
Contributor

@lbalmaceda lbalmaceda left a comment

Choose a reason for hiding this comment

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

LGTM. Only a missing separator on the OIDC guidance.

README.md Outdated Show resolved Hide resolved
@Widcket @lbalmaceda
Update README.md
de91c06 
Co-Authored-By: Luciano Balmaceda <balmacedaluciano@gmail.com>
@Widcket Widcket merged commit ce6311c into master Jan 20, 2020
@Widcket Widcket deleted the docs/add-toc-to-readme branch January 20, 2020 14:31
@Widcket Widcket mentioned this pull request Feb 4, 2020
Merged
sam-w pushed a commit to LoungeBuddy/Auth0.swift that referenced this pull request Mar 11, 2020
@Widcket @lbalmaceda @sam-w
Added a Table of Contents to the README (auth0#338)
d220249 
* Add a ToC to the README

Co-Authored-By: Luciano Balmaceda <balmacedaluciano@gmail.com>
Co-authored-by: Steve Hobbs <steve.hobbs.mail@gmail.com>
sam-w added a commit to LoungeBuddy/Auth0.swift that referenced this pull request Mar 11, 2020
@sam-w
Revert "Added a Table of Contents to the README (auth0#338)"
4a515e6 
This reverts commit d220249.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevehobbsdev stevehobbsdev stevehobbsdev approved these changes

@lbalmaceda lbalmaceda lbalmaceda approved these changes

Assignees
No one assigned
Labels
CH: Changed documentation This adds, fixes or improves documentation
Projects
None yet
Milestone
1.21.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Widcket @stevehobbsdev @lbalmaceda