-
Notifications
You must be signed in to change notification settings - Fork 153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(website): setup sidebar labels and position #1067
Conversation
✅ Deploy Preview for maci-typedoc ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
35450b8
to
0540e4e
Compare
Remaining problem is the index page for solidity docs and typedoc, they're empty now, but I think there should be some content indicating what these following files are. |
0540e4e
to
19ba9a5
Compare
Are you going to tackle that in a separate PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kittybest thanks, just few comments about code conventions.
Yes I think so, since there's also another separate issue #922 . This PR could just for #921. |
7d2fd13
to
58de409
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kittybest thanks!
Description
Setup sidebar position and label by adding scripts.
typedoc.base.json
file in the root folder, for thetypedoc.json
file in each package to extend from.typedoc.json
to thecore
,cli
,crypto
,domainobjs
directories, and adding scripts to gen typedoc in theirpackage.json
➡️ to separate the classes and interfaces, since before they were put together and it's not easy for users to read. Also now we could have theREADME.md
file as the index page for each package.setupTypedoc.ts
, since the typedoc-generating output is totally different now.core/READMD.md
➡️ although it's not directly related to this PR, the links in the file is no longer available since we refactor the whole file structure a lot, which causing the tests of building website fail.Related issue(s)
close #921
Confirmation