Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conversation

VerteDinde
Copy link
Member

@VerteDinde VerteDinde commented Oct 19, 2022

This PR generates a custom sidebar, that displays the modules by category and with more user-friendly names. maker-base has 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-config up to top-level and deleting core and shared-types.

@VerteDinde VerteDinde force-pushed the improve-api-docs branch 2 times, most recently from df4b975 to 9d0656f Compare October 19, 2022 04:18
@codecov
Copy link

codecov bot commented Oct 19, 2022

Codecov Report

Merging #2974 (df07a6f) into main (bb29cd5) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bb29cd5...df07a6f. Read the comment docs.

@VerteDinde VerteDinde marked this pull request as ready for review October 24, 2022 21:23
@VerteDinde VerteDinde changed the title fix: generate custom docs sidebar docs: generate custom docs sidebar Oct 24, 2022
tools/doc-plugin/src/index.tsx Outdated Show resolved Hide resolved
tools/doc-plugin/src/index.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@georgexu99 georgexu99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm (post-todo cleanup + undefined business)

tools/doc-plugin/src/index.tsx Outdated Show resolved Hide resolved
@VerteDinde VerteDinde merged commit 36dcdd0 into main Oct 24, 2022
@VerteDinde VerteDinde deleted the improve-api-docs branch October 24, 2022 22:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.