Skip to content

docs(typedoc): include the events-amqp testing subpath in the API reference entry points (#203)#225

Merged
intech merged 1 commit into
mainfrom
docs/typedoc-testing-subpath-203
Jul 5, 2026
Merged

docs(typedoc): include the events-amqp testing subpath in the API reference entry points (#203)#225
intech merged 1 commit into
mainfrom
docs/typedoc-testing-subpath-203

Conversation

@intech

@intech intech commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #224: the new @connectum/events-amqp/testing subpath was not listed in the package's TypeDoc entryPoints, so pnpm docs:api silently omitted the FakeAmqpAdapter API pages (the docs-repo pages were generated with this fix applied locally — without it, the next full regen would drop them again).

  • packages/events-amqp/typedoc.json: entryPoints += src/testing.ts.

Change type

  • Documentation / tooling (no runtime change)
  • New feature
  • Breaking change

Test plan

Parity coverage

N/A — TypeDoc configuration only; no runtime or contract surface.

Related

🤖 Generated with Claude Code

https://claude.ai/code/session_015Sp8jYmRXyvUmsErDuNJvt

@github-actions github-actions Bot added the type:docs Documentation: guides, README, JSDoc label Jul 5, 2026
@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The TypeDoc configuration file for the events-amqp package is updated to add src/testing.ts as an additional entry point alongside the existing src/index.ts and src/types.ts entries.

Changes

TypeDoc Configuration

Layer / File(s) Summary
Add testing.ts entry point
packages/events-amqp/typedoc.json
Extends the entryPoints array to include src/testing.ts for documentation generation.

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

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title accurately and concisely describes the main change: adding the events-amqp testing subpath to TypeDoc entry points.
Description check ✅ Passed The description covers summary, change type, test plan, parity, and related items, with only minor heading differences from the template.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/typedoc-testing-subpath-203

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.

@pkg-pr-new

pkg-pr-new Bot commented Jul 5, 2026

Copy link
Copy Markdown

Open in StackBlitz

@connectum/auth

npm i https://pkg.pr.new/@connectum/auth@225

@connectum/cli

npm i https://pkg.pr.new/@connectum/cli@225

@connectum/core

npm i https://pkg.pr.new/@connectum/core@225

@connectum/events

npm i https://pkg.pr.new/@connectum/events@225

@connectum/events-amqp

npm i https://pkg.pr.new/@connectum/events-amqp@225

@connectum/events-kafka

npm i https://pkg.pr.new/@connectum/events-kafka@225

@connectum/events-nats

npm i https://pkg.pr.new/@connectum/events-nats@225

@connectum/events-redis

npm i https://pkg.pr.new/@connectum/events-redis@225

@connectum/healthcheck

npm i https://pkg.pr.new/@connectum/healthcheck@225

@connectum/interceptors

npm i https://pkg.pr.new/@connectum/interceptors@225

@connectum/otel

npm i https://pkg.pr.new/@connectum/otel@225

@connectum/protoc-gen-catalog

npm i https://pkg.pr.new/@connectum/protoc-gen-catalog@225

@connectum/reflection

npm i https://pkg.pr.new/@connectum/reflection@225

@connectum/test-fixtures

npm i https://pkg.pr.new/@connectum/test-fixtures@225

@connectum/testing

npm i https://pkg.pr.new/@connectum/testing@225

commit: cbfbe2d

@intech
intech merged commit 940d0a0 into main Jul 5, 2026
21 checks passed
@intech
intech deleted the docs/typedoc-testing-subpath-203 branch July 5, 2026 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation: guides, README, JSDoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant