Closed kamiazya closed 2 months ago
Latest commit: d5e3de529eb1afa239efb5ebecfd03ef1cd1c519
The changes in this PR will be included in the next version bump.
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
[!WARNING]
Rate limit exceeded
@kamiazya has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 48 seconds before requesting another review.
How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.Commits
Files that changed from the base of the PR and between a3adc675b6ae35b39b202e40f9653b2ae027fe86 and d5e3de529eb1afa239efb5ebecfd03ef1cd1c519.
This update introduces several improvements across the project. It upgrades the typedoc
dependency to version ^0.26.3
and includes a new tsdoc.json
configuration file for TSDoc documentation. Enhancements were made to the MermaidPlugin
class for better event handling, and the documentation was updated to guide the usage of the new @mermaid
tag with the TypDoc plugin. The package.json
was also adjusted to reflect these updates appropriately.
Files | Change Summary |
---|---|
example/package.json | Updated typedoc version in devDependencies from ^0.25.13 to ^0.26.3 . |
example/tsdoc.json, tsdoc.json | Introduced new TSDoc JSON configuration file with a tag definition for @mermaid . |
package.json | Added tsdoc.json mapping, included it in the files array, and updated typedoc versions. |
src/plugin.ts | Adjusted event handling in MermaidPlugin class for better parameter passing and registration. |
README.md | Added instructions for using the @mermaid tag in tsdoc comments with the TypDoc plugin. |
🐇 In the world of docs, where code and words align, A mermaid tag now joins, with update divine. Typedoc shines bright, in version fresh and new, A plugin's flow refined, improving all we do. Configuration smooth, our journey's set anew, Hopping through the changes, here's a toast to you! 🐇
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
This pull request updates the typedoc version to 0.26.
The changes include adding a new file
tsdoc.json
and updating thepackage.json
file to include the new version of typedoc. Additionally, thesrc/plugin.ts
file has been modified to fix an issue with theonEndPage
event.Summary by CodeRabbit
New Features
@mermaid
tag in TSDoc comments using thetypedoc-plugin-mermaid
plugin.tsdoc.json
configuration file for TSDoc documentation.Bug Fixes
MermaidPlugin
class for improved performance.Documentation
@mermaid
tag and setting up TSDoc configuration.Chores
typedoc
version indevDependencies
to^0.26.3
.