Skip to content

docs: improve callout and voice widget LLM exports - #611

Merged
Devon-White merged 4 commits into
mainfrom
Devon/388-callouts-widgets
Aug 21, 2026
Merged

docs: improve callout and voice widget LLM exports#611
Devon-White merged 4 commits into
mainfrom
Devon/388-callouts-widgets

Conversation

@Devon-White

@Devon-White Devon-White commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Part 2 of #388, stacked on #610.

  • hides all 17 VoiceWidget instances and widget-only instructions from .md exports
  • preserves the existing provider voice documentation as the machine-readable source
  • adds targeted titles where legal, credential, network-security, or availability warnings otherwise lose intent
  • extends the local/manual preview assertions across all canonical TTS provider routes; the checker is intentionally not wired into CI

Validation:

  • yarn test:scripts
  • yarn fern-md-check
  • yarn check-llm-exports after the Fern preview deploys

Retarget to main after #610 merges.

@github-actions

github-actions Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

@Devon-White
Devon-White force-pushed the Devon/388-callouts-widgets branch 2 times, most recently from bf2feab to e8c4116 Compare August 19, 2026 18:09
@Devon-White Devon-White changed the title docs: filter interactive voice content from LLM exports docs: improve callout and voice widget LLM exports Aug 19, 2026
@Devon-White
Devon-White force-pushed the Devon/388-callouts-widgets branch from d6a3401 to dcebb53 Compare August 19, 2026 19:07
hey-august
hey-august previously approved these changes Aug 21, 2026

@hey-august hey-august left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

  • All 17 instances are inside balanced blocks, and the only substantive prose hidden with them is duplicated elsewhere on the page, so nothing drops out of the exports.
  • The 8 new callout titles name the actual hazard and add no new claims on the compliance pages.
  • All 16 manifest routes match the pages' slug: frontmatter, including the non-obvious gcloud and amazon-polly ones.
  • yarn test:scripts and yarn fern-md-check pass.

One thing I fixed on the branch (70301b4): google and polly were the only provider pages where the ## Voices section contained nothing but the ignored widget block, so the .md export rendered an empty heading. Each now has a one-line pointing at the provider's voice list.

Note: the new paths array expansion in check-llm-exports.mjs has no unit test, so a malformed manifest entry would silently produce zero checks.

Base automatically changed from Devon/388-export-correctness to main August 21, 2026 18:57
@Devon-White
Devon-White merged commit a2ae1e6 into main Aug 21, 2026
2 of 3 checks passed
@Devon-White
Devon-White deleted the Devon/388-callouts-widgets branch August 21, 2026 19:07
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.

2 participants