Skip to content

docs: clarify TypeDoc coverage after Lit adapter#8

Closed
SutuSebastian wants to merge 1 commit into
mainfrom
blume/sync-docs-2026-07-17
Closed

docs: clarify TypeDoc coverage after Lit adapter#8
SutuSebastian wants to merge 1 commit into
mainfrom
blume/sync-docs-2026-07-17

Conversation

@SutuSebastian

@SutuSebastian SutuSebastian commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

PRs checked

PR Surfaces Docs status
#4 layer handles / cancelQueued { id } core + adapters Already documented on main (core-api, serial-queues, migration, glossary)
#6 Blume docs site + Lit plan apps/docs Shipped
#7 Lit adapter packages/lit + docs Shipped with adapter page/recipes; TypeDoc index wording was stale

Test plan

  • bun run docs:validate -- --strict
  • bun run docs:check -- --isolated
  • bun run docs:build

Summary by CodeRabbit

  • Documentation
    • Clarified the API reference coverage and how documentation is generated.
    • Added a dedicated Lit adapter entry linking to its adapter documentation.
    • Updated reference guidance to distinguish core/framework API documentation from adapter-specific pages.

Lit ships without a typedoc entryPoint; stop claiming every adapter is in the generated API index and link the Lit adapter page instead.
@changeset-bot

changeset-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8a2e985

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@SutuSebastian

Copy link
Copy Markdown
Contributor Author

Closing — folding TypeDoc coverage fix into the Alpine adapter branch instead of a standalone docs PR.

@SutuSebastian
SutuSebastian deleted the blume/sync-docs-2026-07-17 branch July 17, 2026 13:28
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f37c648c-400c-4f6d-89bd-03f9a841f58b

📥 Commits

Reviewing files that changed from the base of the PR and between a886aa9 and 8a2e985.

📒 Files selected for processing (2)
  • apps/docs/content/reference/api/index.mdx
  • apps/docs/content/reference/index.mdx

📝 Walkthrough

Walkthrough

The documentation clarifies generated TypeDoc coverage, explains per-entry generation from typedoc.json, and links Lit documentation from the adapter page.

Changes

API reference documentation

Layer / File(s) Summary
Reference scope and Lit navigation
apps/docs/content/reference/*.mdx
API reference pages now list the covered framework entries, describe per-entry TypeDoc generation, and add a Lit adapter link.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch blume/sync-docs-2026-07-17

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

Comment @coderabbitai help to get the list of available commands.

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.

1 participant