Skip to content

chore(docs): regenerate telemetry api-docs (unblocks Deploy → Vercel)#377

Merged
blove merged 1 commit into
mainfrom
claude/fix-api-docs-drift
May 16, 2026
Merged

chore(docs): regenerate telemetry api-docs (unblocks Deploy → Vercel)#377
blove merged 1 commit into
mainfrom
claude/fix-api-docs-drift

Conversation

@blove
Copy link
Copy Markdown
Contributor

@blove blove commented May 16, 2026

Summary

`apps/website/content/docs/telemetry/api/api-docs.json` has drifted 19 lines on main — a recent telemetry change added a public API entry but didn't regenerate the docs.

Why this matters

The `Verify generated API docs are committed` step inside `Website — lint / build` has been failing on every push to main since the drift landed. That job gates the entire `Deploy → Vercel` job that handles auto-deploys for:

  • cacheplane.ai (marketing site)
  • cockpit.cacheplane.ai
  • examples.cacheplane.ai
  • demo.cacheplane.ai ← this is the immediate motivator

Result: the canonical demo at demo.cacheplane.ai has been stuck on a stale build for 3+ commits despite the auto-deploy wiring being correct. Discovered while diagnosing the missing root-tokens regression that ships in v0.0.32–v0.0.34 (fixed for npm consumers in v0.0.35 via PR #375).

Fix

`npm run generate-api-docs` → commit the regenerated file. Diff is purely additive (19 inserts, 0 deletes) — a new API entry someone added to telemetry but forgot to regen.

Test plan

  • Regen produces no further diff
  • CI green
  • After merge: next main push triggers `Deploy → Vercel`; demo.cacheplane.ai shows v0.0.35's lifecycle-guaranteed root token injection (verifiable via `document.getElementById('ngaf-chat-root-tokens')` returning a truthy element)

🤖 Generated with Claude Code

apps/website/content/docs/telemetry/api/api-docs.json drifted 19
lines on main — a recent telemetry change added a public API entry
but didn't regenerate the docs. The `Verify generated API docs are
committed` step in Website — lint / build has been failing on every
push to main since, and that job gates the entire Deploy → Vercel
job (which is the one that auto-deploys demo.cacheplane.ai +
cacheplane.ai + cockpit.cacheplane.ai + examples.cacheplane.ai).

Result: the demo has been stuck on a stale build despite the auto-
deploy wiring being correct. Regenerated via `npm run generate-api-
docs`; diff is purely additive (19 inserts, 0 deletes).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cacheplane Ready Ready Preview, Comment May 16, 2026 9:00pm

Request Review

@blove blove merged commit 542e554 into main May 16, 2026
16 checks passed
blove added a commit that referenced this pull request May 16, 2026
… redeploy) (#379)

* chore(docs): regenerate telemetry api-docs (unblocks deploy job)

apps/website/content/docs/telemetry/api/api-docs.json drifted 19
lines on main — a recent telemetry change added a public API entry
but didn't regenerate the docs. The `Verify generated API docs are
committed` step in Website — lint / build has been failing on every
push to main since, and that job gates the entire Deploy → Vercel
job (which is the one that auto-deploys demo.cacheplane.ai +
cacheplane.ai + cockpit.cacheplane.ai + examples.cacheplane.ai).

Result: the demo has been stuck on a stale build despite the auto-
deploy wiring being correct. Regenerated via `npm run generate-api-
docs`; diff is purely additive (19 inserts, 0 deletes).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(chat): explain the dual ensureChatRootStyles path

Document why we keep both the module-eval side-effect call AND the
explicit constructor calls in the top-level chat compositions: the
side-effect is the fast path for source-resolution consumers, the
constructor calls are the guaranteed path for production-bundled
consumers where tree-shaking can drop the side effect.

Also: this commit's libs/ change unblocks the canonical-demo Vercel
redeploy that's been stuck since v0.0.32 (the prior libs/ commits all
failed CI's website-lint-build api-docs check; #377 fixed that but
its diff didn't trigger demo_changed=true).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
blove added a commit that referenced this pull request May 17, 2026
Same class of drift as PR #377: someone landed a chat-lib public API
change on main without regenerating apps/website/content/docs/chat/
api/api-docs.json. Caught here because CI's Verify generated API
docs are committed step fails on the stale file. Regenerated via
npm run generate-api-docs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
blove added a commit that referenced this pull request May 17, 2026
#383)

* docs: spec for welcome-suggestions top-3 + overflow dropdown

Reduces the demo's welcome-state visual footprint from 17 stacked
chips to 3 curated chips + a "More prompts" dropdown styled like the
existing model picker. Pure demo-side composition reusing chat-welcome-
suggestion + chat-select primitives; no @ngaf/chat API changes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs: plan for welcome-suggestions top-3 + overflow dropdown

6 tasks: split data, build component+spec, migrate embed/popup/sidebar
modes, verify+PR. Demo-side only.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(examples-chat): split WELCOME_SUGGESTIONS into FEATURED + MORE

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(examples-chat): WelcomeSuggestionsComponent — 3 chips + overflow dropdown

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(examples-chat): embed-mode uses WelcomeSuggestionsComponent

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(examples-chat): popup-mode uses WelcomeSuggestionsComponent

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* refactor(examples-chat): sidebar-mode uses WelcomeSuggestionsComponent

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(docs): regenerate chat api-docs (unrelated drift on main)

Same class of drift as PR #377: someone landed a chat-lib public API
change on main without regenerating apps/website/content/docs/chat/
api/api-docs.json. Caught here because CI's Verify generated API
docs are committed step fails on the stale file. Regenerated via
npm run generate-api-docs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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