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

chore: update typedoc to 0.26.4 #9695

Closed
wants to merge 3 commits into from
Closed

chore: update typedoc to 0.26.4 #9695

wants to merge 3 commits into from

Conversation

LuqiPan
Copy link
Contributor

@LuqiPan LuqiPan commented Jul 12, 2024

closes: #9681
refs: #XXXX

Description

Reading changelog for typedoc, I still don't have a good grasp of what features we're using. So I'm opening this PR to rely on our CI to catch errors.

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

I git grep'ed almost all keywords in the breaking changes section of v0.26.0 and didn't find any hits

Upgrade Considerations

Copy link

cloudflare-workers-and-pages bot commented Jul 12, 2024

Deploying agoric-sdk with  Cloudflare Pages  Cloudflare Pages

Latest commit: 517fb24
Status: ✅  Deploy successful!
Preview URL: https://f14d4d42.agoric-sdk.pages.dev
Branch Preview URL: https://9681-update-typedoc.agoric-sdk.pages.dev

View logs

@LuqiPan
Copy link
Contributor Author

LuqiPan commented Jul 12, 2024

Well the most generic keyword, includes, seems like we're using it. And typedoc is complaining about it:

TypeDoc exiting with unexpected error:
Error: Unknown option 'includes' You may have meant:

In v0.26.0 breaking changes section

...
Removed --includes option, use the @document tag instead.
...

This is something I'm gonna try to resolve for typedoc to work

@LuqiPan
Copy link
Contributor Author

LuqiPan commented Jul 18, 2024

Closing as this PR is obsolete by #9727

@LuqiPan LuqiPan closed this Jul 18, 2024
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.

update typedoc to 0.26+
1 participant