fix(docs): move provider docs to source code #7275
Merged
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
core
github-actions
bot
added
the
legacy
github-actions
bot
removed
the
legacy
balazsorban44
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| id: "faceit", | ||
| name: "FACEIT", | ||
| type: "oauth", | ||
| authorization: "https://accounts.faceit.com/accounts?redirect_popup=true", |
Check failure
Code scanning / CodeQL
Hard-coded credentials
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.
☕️ Reasoning
Move the provider's documentation to the source code.
Currently, I only documented like ~4 providers, I need to finish once I'm back from holidays 🏖️ , like in ~10 days.
The proposed structure for each provider page is as follows:
The idea is that they look similar to the adapter pages, and the structure and content in all of them are similar, so if the user reads one, they can then read the others easily.
We need to remove these:
From the pre-generated code. They make the pages look pretty messy and confusing for the user.
We also need to better explain the
profile()callback and why documenting the properties of the user object it receives is helpful when overridden.🧢 Checklist
Tests🎫 Affected issues
None
Fixes: INSERT_ISSUE_LINK_HERE
📌 Resources