docs: move to typedoc

[TobiTenno]

Update to typedoc

Summary by CodeRabbit

• Chores
  • Updated documentation generation tooling for improved consistency and maintainability.
  • Pinned GitHub Actions versions to ensure reliable CI/CD workflows.
  • Optimized build process dependency installation.
  • Enhanced development environment configuration.

[coderabbitai]

Warning

Review limit reached

@TobiTenno, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 55 minutes and 27 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 27e1ea96-284f-48f5-88d8-eae7cf99d80f

📥 Commits

Reviewing files that changed from the base of the PR and between 70d3ee9 and 6f0297d.

📒 Files selected for processing (4)

• .github/workflows/ci.yaml
• .github/workflows/codeql-analysis.yml
• .github/workflows/release.yaml
• .pinact.yaml

📝 Walkthrough

Walkthrough

Documentation generation is migrated from JSDoc to TypeDoc by updating the build script and introducing TypeDoc configuration, while the docs workflow is hardened with pinned action versions and deterministic dependency installation, and the project environment is cleaned up with macOS ignore rules.

Changes

Documentation Toolchain Migration

Layer / File(s)	Summary
TypeDoc configuration and build script typedoc.json, package.json	The build:docs npm script now invokes typedoc directly instead of tsdown && jsdoc. A new typedoc.json configuration specifies entry points under src/*.ts, output directory, exclusions for test/spec files, and compiler/TypeDoc options.
Workflow hardening and environment setup .github/workflows/docs.yaml, .gitignore	GitHub Actions steps are pinned to specific commit SHAs; dependency installation switches to npm ci for reproducible builds. .gitignore gains macOS-specific rules for .DS_Store.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 TypeDoc takes the stage, goodbye JSDoc old friend,
Pinned actions now keep things secure, on which we depend,
Config flows clean, and npm installs precise,
A rabbit's refactored docs—could not be nicer! 📚✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: move to typedoc' accurately summarizes the main change: migrating documentation generation from jsdoc to typedoc.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch dependabot-npm_and_yarn-biomejs-biome-2.4.15

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coveralls]

Coverage Report for CI Build 27248914364

Warning

No base build found for commit 0231af7 on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 62.215%

Details

• Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →

---

Coverage Stats

Relevant Lines:	2295
Covered Lines:	1381
Line Coverage:	60.17%
Relevant Branches:	296
Covered Branches:	231
Branch Coverage:	78.04%
Branches in Coverage %:	Yes
Coverage Strength:	124.1 hits per line

---

💛 - Coveralls

[github-actions]

🎉 This PR is included in version 2.0.13 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀