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

Improve SDK documentation #402

Merged
merged 9 commits into from
Aug 7, 2023
Merged

Improve SDK documentation #402

merged 9 commits into from
Aug 7, 2023

Conversation

TucksonDev
Copy link
Contributor

@TucksonDev TucksonDev commented Jul 14, 2023

This PR changes the process by which the SDK documentation is generated. It transfers the process to this repo (instead of running the command in the sdk repo), uses and updated version of the markdown plugin for typedoc, and improves the general output by reestructuring the information displayed and generating a custom sidebar.

There are several important changes that should be reviewed:

  • Upgraded typedoc-plugin-markdown version to the latest "next" version because it contains many improvements over the latest released version. To avoid breaking future deployments if a new "next" version is released, I've hardcoded the one being used (4.0.0-next.17). You can see the difference between the current stable version and the "next" version in those links.
  • typedoc generated documentation and docusaurus are highly dependent on each other, so I've installed typedoc and its dependencies in this repo. In any case, we can revert back to have those in the SDK repo if needed (we would just need to add the new config there)
  • Modified some of the package.json scripts to handle typedoc in this repo instead of the SDK
  • Documentation is now generated in website/sdk-docs instead of arbitrum-sdk/docs. It makes sense tonot place documentation files there. I'm not sure if "website" is the best place to add those documents to, but looks like a good option. I'm open for alternative suggestions.

Preview

@vercel
Copy link

vercel bot commented Jul 14, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nitro-docs ✅ Ready (Inspect) Visit Preview Aug 4, 2023 3:41pm

Copy link
Contributor

@DZGoldman DZGoldman left a comment

Choose a reason for hiding this comment

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

lgtm!

@TucksonDev TucksonDev merged commit 8c68e91 into master Aug 7, 2023
4 checks passed
@TucksonDev TucksonDev deleted the improve-sdk-output branch August 7, 2023 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants