feat: Typedoc for authenticateRequest, verifyToken, verifyWebhook #2293
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
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.
🔎 Previews:
What does this solve?
Use autogenerated Typedoc for the docs pages of
authenticateRequest(),verifyToken(), andverifyWebhook(). This way it'll be tied to the source code, automatically updated 👍What changed?
It seems that #2292 needs to be merged first so that the "Docs build script" will be happy :)
In the verifyToken and verifyWebhook docs you can see that a "Returns" heading + content was added. Typedoc automatically generates this and I think we should keep it. There can be cases where the return type is a bit more complicated and we want to document it more, we could do it through that. All Typedoc generated pages then will have the same structure.
Checklist