Skip to content

Update OpenAI plugin documentation and screenshots - #117

Merged
SeoFood merged 1 commit into
mainfrom
seofood/openai-plugin-1-3-1-website
Jul 29, 2026
Merged

Update OpenAI plugin documentation and screenshots#117
SeoFood merged 1 commit into
mainfrom
seofood/openai-plugin-1-3-1-website

Conversation

@SeoFood

@SeoFood SeoFood commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • update the OpenAI / ChatGPT add-on page to plugin 1.3.1 in English and German
  • document GPT Transcribe, GPT Live Transcribe, transcription context, language and dictionary hints, live delay, and account-scoped model refresh
  • explain transcription engines, LLM workflows, text-to-speech, connection methods, and practical use cases
  • replace the localized main screenshots and regenerate optimized PNG and WebP assets
  • enable GitHub Flavored Markdown for MDX so add-on tables render correctly

Why

The page still described OpenAIPlugin 1.2.0 and showed the previous settings UI, while 1.3.1 is now published. The MDX tables were also rendered as literal pipe-delimited text because remark-gfm was installed but not configured.

Impact

Visitors now see the current configuration UI and can understand how OpenAI transcription, workflows, and text-to-speech fit into TypeWhisper. Add-on Markdown tables render semantically and remain horizontally contained on mobile.

Validation

  • npm run build
  • npx astro check
  • npx astro build
  • npm run test:i18n
  • npm run test:unit
  • Playwright: /en/addons/openai/ and /de/addons/openai/ at 1440×1000 and 390×844, with no page overflow or JavaScript errors
  • verified WebP assets load at 1344×1950 and PNG optimizations are pixel-identical to the provided sources

Summary by CodeRabbit

  • New Features

    • Added improved Markdown support, including tables, task lists, and strikethrough formatting.
    • Updated OpenAI/ChatGPT add-on documentation for version 1.3.1, including new transcription models, context settings, preview behavior, and model availability.
    • Documented account-specific model catalogs, caching, and fallback behavior for ChatGPT Login.
  • Documentation

    • Clarified translation limitations, configuration options, and updated the required TypeWhisper host version to 1.5.0.
  • Style

    • Refreshed OpenAI add-on screenshots in English, German, and the default documentation.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: fb3a1541-21b7-4689-b089-3b47ca455d4a

📥 Commits

Reviewing files that changed from the base of the PR and between f784d1d and 48f07c6.

⛔ Files ignored due to path filters (3)
  • public/screenshots/de/plugins/openai.png is excluded by !**/*.png
  • public/screenshots/en/plugins/openai.png is excluded by !**/*.png
  • public/screenshots/plugins/openai.png is excluded by !**/*.png
📒 Files selected for processing (6)
  • astro.config.mjs
  • public/screenshots/de/plugins/openai.webp
  • public/screenshots/en/plugins/openai.webp
  • public/screenshots/plugins/openai.webp
  • src/content/addons/de/openai.mdx
  • src/content/addons/en/openai.mdx

📝 Walkthrough

Walkthrough

The PR enables GFM in MDX, updates OpenAI add-on documentation for version 1.3.1 in English and German, and replaces three localized screenshot assets.

Changes

OpenAI add-on 1.3.1

Layer / File(s) Summary
MDX GFM configuration
astro.config.mjs
Configures the MDX integration with remark-gfm.
Add-on 1.3.1 documentation
src/content/addons/en/openai.mdx, src/content/addons/de/openai.mdx
Updates release metadata, transcription and LLM model documentation, caching and fallback behavior, configuration fields, release notes, and the required TypeWhisper host version.
Updated OpenAI screenshots
public/screenshots/*/plugins/openai.webp
Replaces the German, English, and default WebP screenshot assets.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Poem

A rabbit hops through Markdown’s rows,
While OpenAI’s newer story grows.
Fresh models, previews, notes in line,
New screenshots sparkle and shine.
GFM ears perk up—what a fine design!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: OpenAI plugin documentation updates and refreshed screenshots.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch seofood/openai-plugin-1-3-1-website

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.

@SeoFood
SeoFood marked this pull request as ready for review July 29, 2026 22:56
@SeoFood

SeoFood commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@SeoFood
SeoFood merged commit 0cc0e96 into main Jul 29, 2026
2 checks passed
@SeoFood
SeoFood deleted the seofood/openai-plugin-1-3-1-website branch July 29, 2026 23:04
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