docs: generate custom docs sidebar #2974
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
VerteDinde
force-pushed
the
improve-api-docs
branch
2 times, most recently
from
df4b975 to
9d0656f
Compare
Codecov Report
@@ Coverage Diff @@
## main #2974 +/- ##
=======================================
Coverage 73.78% 73.78%
=======================================
Files 66 66
Lines 2144 2144
Branches 423 423
=======================================
Hits 1582 1582
Misses 357 357
Partials 205 205 Continue to review full report at Codecov.
|
VerteDinde
force-pushed
the
improve-api-docs
branch
from
d930a1c to
555e5ec
Compare
VerteDinde
force-pushed
the
improve-api-docs
branch
from
555e5ec to
24a600a
Compare
VerteDinde
changed the title
erickzhao
reviewed
Oct 24, 2022
georgexu99
approved these changes
Oct 24, 2022
erickzhao
approved these changes
Oct 24, 2022
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 generates a custom sidebar, that displays the modules by category and with more user-friendly names.
maker-basehas been sorted into "Utils & Internal Helpers" - other modules should be categorized by name.View live here: https://63570052b003ce2ebe12b5cb--marvelous-choux-77d0b7.netlify.app/
Note: Additional improvements, such as added READMEs and internal cleanup, will be broken into separate PRs. This includes bringing
forge-configup to top-level and deletingcoreandshared-types.