chore: documentation overhaul with typedoc #11423
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit af301c7:
|
GoodBoyDigital
approved these changes
May 16, 2025
|
Awesome job @Zyie! I'm glad we got the big lift here out of the way in this PR. Do you want to capture a project board with those remaining tasks? |
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.
This PR overhauls our documentation to use TypeDoc and removes the documentation quirks from using webdoc
This also introduces the idea that anything that has been exported should explicitly state whether or not it is meant for internal or public use. This is done by using the
@internaltag. This should help us clearly define our public API and give us more freedom to change the internals of pixiTo help ensure our docs remain consistent there is also a custom eslint plugin that forces a tag to be applied to anything that has been exported
https://pixijs.download/feat/typedoc/docs/index.html
Follow up tasks:
@experimentaltags@standard/@advancedtags