docs: api reference restructure #6608
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
balazsorban44
requested review from
ubbe-xyz,
ThangHuuVu and
ndom91
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
github-actions
bot
added
core
balazsorban44
force-pushed
the
docs/api-reference-restructure
branch
from
fce1508
to
84e14d7
Compare
balazsorban44
had a problem deploying
to
Preview
GitHub Actions
Failure
balazsorban44
had a problem deploying
to
Preview
GitHub Actions
Failure
balazsorban44
had a problem deploying
to
Preview
GitHub Actions
Failure
github-actions
bot
added
adapters
balazsorban44
force-pushed
the
docs/api-reference-restructure
branch
from
8e69a23
to
354b034
Compare
github-actions
bot
removed
adapters
balazsorban44
had a problem deploying
to
Preview
GitHub Actions
Failure
ThangHuuVu
approved these changes
Feb 4, 2023
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.
Clean up the structure under /reference. Each module is its own section, listing the main and all submodules, in each module, it lists all functions, interfaces, types, etc.
This will greatly improve discoverability. Huge thanks to @tgreyuk for taking the feedback to figure out the best format and implementing it in
typedoc-plugin-markdown. 🙏Disclaimer: Even though we are still figuring out some minor formatting changes, I think the new format is so much better than the current one, that I want to go with it as soon as possible.