Skip to content

[codex] add pronunciation dictionary guidance#96

Draft
Kilerd wants to merge 1 commit into
mainfrom
codex/pronunciation-dictionary-instructions
Draft

[codex] add pronunciation dictionary guidance#96
Kilerd wants to merge 1 commit into
mainfrom
codex/pronunciation-dictionary-instructions

Conversation

@Kilerd

@Kilerd Kilerd commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Added a Pronunciation Dictionaries guide under Fine-grained Control.
  • Documented when to use pronunciation dictionaries, what key and value should contain, and how inline versus managed dictionaries are processed.
  • Linked the new guide from the Fine-grained Control overview, navigation, and llms.txt.

Why

Users need a reusable instruction for pronunciation dictionaries that reflects the edge-api and platform-api behavior: request validation, reference resolution, caching, ordered merge semantics, sanitization, and inference-side replacement.

Impact

Developers can now decide when to use a dictionary instead of inline phoneme tags and understand how to author entries safely.

Validation

  • git diff --check
  • node -e "JSON.parse(require('fs').readFileSync('docs.json', 'utf8')); console.log('docs.json ok')"
  • npx prettier --check developer-guide/core-features/fine-grained-control.mdx developer-guide/core-features/fine-grained-control/pronunciation-dictionaries.mdx
  • npx prettier --check --parser markdown llms.txt
  • npx mint openapi-check api-reference/openapi.json

npx mint broken-links still reports existing broken links in .mintlify/skills and temp; the new page is not part of those failures.

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 75e2fe51-8119-4bd7-aa23-de7d9a6c72e7

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/pronunciation-dictionary-instructions

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.

@mintlify

mintlify Bot commented Jun 29, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hanabiaiinc 🟢 Ready View Preview Jun 29, 2026, 11:42 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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