Skip to content

[SDK-3680] README redesign#459

Merged
jimmyjames merged 9 commits intomasterfrom
readme
Oct 25, 2022
Merged

[SDK-3680] README redesign#459
jimmyjames merged 9 commits intomasterfrom
readme

Conversation

@jimmyjames
Copy link
Copy Markdown
Contributor

Updates the README per the new design specs.

Notes:

  • There was no existing EXAMPLES.md, so I created one and populated with the example content that was contained in the README
  • The README had a lot of API-level documentation within it. I removed most of it, as it is covered in the API reference documentation now more clearly linked-to in the README.
  • This PR does not the banner, as we are awaiting final design. We will either update this PR when it is available, or follow-up with an additional PR.

@jimmyjames jimmyjames requested a review from a team as a code owner October 14, 2022 00:02
@jimmyjames jimmyjames added the review:medium Medium review label Oct 14, 2022
@jimmyjames jimmyjames force-pushed the readme branch 2 times, most recently from 3279414 to a339ed3 Compare October 17, 2022 14:10
frederikprijck
frederikprijck previously approved these changes Oct 17, 2022
README.md Outdated

## License
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's code of conduct guidelines]((https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md))
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Extra brackets here

Suggested change
- [Auth0's code of conduct guidelines]((https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md))
- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)

Copy link
Copy Markdown
Contributor Author

@jimmyjames jimmyjames Oct 24, 2022

Choose a reason for hiding this comment

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

Good catch! Fixed in a new commit.

@jimmyjames jimmyjames merged commit e811fa4 into master Oct 25, 2022
@jimmyjames jimmyjames deleted the readme branch October 25, 2022 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review:medium Medium review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants