feat: In-editor class reference documentation #104
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
|
bruno-garcia
approved these changes
Feb 19, 2025
There was a problem hiding this comment.
Would be nice to have a note about this script in the CONTRIBUTING.md file.
Or rather, a note about documentation, describing docs.sentry.io and also this script, and when to contribute to each
There was a problem hiding this comment.
Tracked in #122 as we don't have a contributing guide
|
I'll keep it open for a little while longer, so we can synchronize it with getsentry/sentry-docs#12774 if needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds built-in class documentation which can be used offline.
Notable changes:
src/genfolderIt would be nice to add static checks to CI to test if the API changed but the documentation wasn't updated. Tracked in #117.
Resolves #8
Demonstration
sentry_builtin_doc.mp4