Link to the API docs from the README #168
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevehobbsdev
approved these changes
Jun 24, 2022
Widcket
added a commit
that referenced
this pull request
Jul 20, 2022
* Remove license header (#140) * Add migration guide (#141) * Drop support for old Swift versions [SDK-3394] (#142) * Drop support for old Swift versions * Remove Xcode 12 from the build matrix * Update year in license file (#144) * Drop old platform versions (#143) * Update README [SDK-3396] (#147) * Update README * Add First Availability label * Remove ID token validator [SDK-3395] (#145) * Remove ID token validator * Add changes to migration guide * Drop support for Objective-C [SDK-3405] (#149) * Add `.swiftpm` to `.gitignore` (#151) * Add CONTRIBUTING.md (#150) * Add missing unit test (#146) * Add missing test * Add empty JSON body test case * Add support policy [SDK-3403] (#148) Add support policy * Update API doc comments (#152) * Move test files back to `JWTDecodeTests` (#154) * Update the library description (#153) Update library description * Add subscript getter for claims [SDK-3421] (#156) * Update playground (#157) * Improve display of `DecodeError` [SDK-3427] (#158) * Improve errors * Remove extra whitespace * Apply recommended Xcode 14 settings (#159) * Improve API docs (#160) * [SDK-3434] Update issues templates (#161) * [SDK-3434] Update issue templates * Remove "FAQ.md" reference, as there is no file * Update .github/ISSUE_TEMPLATE/Bug Report.yml * Update .github/ISSUE_TEMPLATE/Bug Report.yml * Update .github/ISSUE_TEMPLATE/Feature Request.yml * Update .github/ISSUE_TEMPLATE/Feature Request.yml * Update .github/ISSUE_TEMPLATE/config.yml * Update .github/ISSUE_TEMPLATE/config.yml * Update checklist grouping * Update pull request template Co-authored-by: Rita Zerrizuela <zeta@widcket.com> * Rename `DecodeError` and error case (#162) * Use SUT terminology in unit tests (#163) * Add DocC API generation * Ignore docs.archive subfolder for temp data * Add to shiprc * Implement feedback * Add generated API documentation to repo * Update generated API documentation for repo * Improve API docs generation (#167) * Re-generate API docs (#169) * Link to the API docs from the README (#168) * Release 3.0.0-fa.0 (#170) * Use Codecov orb (#173) * Replace OSX with macOS in schemes and targets (#175) * Add placeholders to issue forms (#176) * Update README for GA [SDK-3499] (#177) Update README for GA * Merge `master` into `fa` (#178) Co-authored-by: Evan Sims <evan.sims@auth0.com> Co-authored-by: Evan Sims <evan.sims@okta.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR updates the README to link to the API docs.
Testing
Checklist