Skip to content
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

Merged
merged 1 commit into from
Jan 23, 2024
Merged

feat(website): setup sidebar labels and position #1067

merged 1 commit into from
Jan 23, 2024

Conversation

kittybest
Copy link
Collaborator

@kittybest kittybest commented Jan 19, 2024

Description

Setup sidebar position and label by adding scripts.

  • create a typedoc.base.json file in the root folder, for the typedoc.json file in each package to extend from.
  • adding typedoc.json to the core, cli, crypto, domainobjs directories, and adding scripts to gen typedoc in their package.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 the README.md file as the index page for each package.
  • rewrite the whole setupTypedoc.ts, since the typedoc-generating output is totally different now.
  • add sidebar config to the auto-generated files, to make the sidebar looks more readable.
  • update 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

Copy link

netlify bot commented Jan 19, 2024

Deploy Preview for maci-typedoc ready!

Name Link
🔨 Latest commit 6206a1b
🔍 Latest deploy log https://app.netlify.com/sites/maci-typedoc/deploys/65afe70964c50700088961fe
😎 Deploy Preview https://deploy-preview-1067--maci-typedoc.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kittybest kittybest force-pushed the feat/sidebar branch 7 times, most recently from 35450b8 to 0540e4e Compare January 22, 2024 17:21
@kittybest
Copy link
Collaborator Author

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.

@kittybest kittybest marked this pull request as ready for review January 22, 2024 17:23
@ctrlc03
Copy link
Collaborator

ctrlc03 commented Jan 22, 2024

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.

Are you going to tackle that in a separate PR?

Copy link
Collaborator

@0xmad 0xmad left a 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.

website/src/scripts/setupTypedoc.ts Outdated Show resolved Hide resolved
website/src/scripts/setupTypedoc.ts Outdated Show resolved Hide resolved
website/src/scripts/utils.ts Outdated Show resolved Hide resolved
website/src/scripts/utils.ts Outdated Show resolved Hide resolved
website/src/scripts/utils.ts Outdated Show resolved Hide resolved
website/src/scripts/setupTypedoc.ts Outdated Show resolved Hide resolved
website/src/scripts/setupTypedoc.ts Outdated Show resolved Hide resolved
@kittybest
Copy link
Collaborator Author

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.

Are you going to tackle that in a separate PR?

Yes I think so, since there's also another separate issue #922 . This PR could just for #921.

@kittybest kittybest force-pushed the feat/sidebar branch 5 times, most recently from 7d2fd13 to 58de409 Compare January 23, 2024 15:37
Copy link
Collaborator

@0xmad 0xmad left a comment

Choose a reason for hiding this comment

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

@kittybest thanks!

@ctrlc03 ctrlc03 merged commit e5f36d0 into dev Jan 23, 2024
17 of 18 checks passed
@ctrlc03 ctrlc03 deleted the feat/sidebar branch January 23, 2024 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

website: build customized sidebar for the documents
3 participants