Fix #270: update package module example

[flyingrobots]

Summary

• add a Worldline-first package module example to the root barrel docs
• add a package surface guard that keeps stale WarpApp.open() examples out of the module hover docs

Closes #270

Validation

• npm exec vitest run test/unit/scripts/v18-package-surface-audit.test.ts
• pre-push IRONCLAD gates 0-7 passed with WARP_QUICK_PUSH=1

[coderabbitai]

Warning

Review limit reached

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

More reviews will be available in 26 minutes and 19 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: 8eb57855-bd71-4d7b-af6b-f11ded2500c9

📥 Commits

Reviewing files that changed from the base of the PR and between a21fb8b and 9a01f10.

📒 Files selected for processing (2)

• index.ts
• test/unit/scripts/v18-package-surface-audit.test.ts

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix-270-index-worldline-example

---

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.}

[github-actions]

Release Preflight

• package version: 18.0.0
• prerelease: false
• npm dist-tag on release: latest
• npm pack dry-run: passed
• jsr publish dry-run: passed

If you tag this commit as v18.0.0, release workflow will publish.

[flyingrobots]

Code Lawyer Self-Review Findings

@codex please confirm this finding before merge.

Severity	File	Lines	Infraction	Recommended mitigation
P4 Test robustness	test/unit/scripts/v18-package-surface-audit.test.ts	L14	moduleDoc is sliced by searching for import GitGraphAdapter, coupling the guard to a particular import name/order. If that import changes, the test can accidentally inspect the wrong range.	Slice the package module documentation by the JSDoc terminator instead of by the first import statement, and fail explicitly if the module doc block is missing.

I will address this in a follow-up commit on this PR branch.

[flyingrobots]

Code Lawyer Activity Summary

@codex please confirm this review posture.

Source	Severity	File	Lines	Issue	Commit	Outcome
Self-review	P4	test/unit/scripts/v18-package-surface-audit.test.ts	L14	Module-doc guard depended on finding import GitGraphAdapter, making the checked range import-order dependent.	9a01f105	Switched to slicing by the JSDoc terminator and failing explicitly if the package module doc is missing.
PR threads	None	n/a	n/a	No unresolved review threads found by GraphQL review-thread query.	n/a	No PR-thread fix required.

Validation:

• npm exec vitest run test/unit/scripts/v18-package-surface-audit.test.ts
• npm run typecheck:test
• pre-push IRONCLAD gates 0-7 passed with WARP_QUICK_PUSH=1

[github-actions]

Release Preflight

• package version: 18.0.0
• prerelease: false
• npm dist-tag on release: latest
• npm pack dry-run: passed
• jsr publish dry-run: passed

If you tag this commit as v18.0.0, release workflow will publish.