Skip to content

Sync release docs and marketing#3

Merged
austin-thesing merged 3 commits into
mainfrom
release/docs-marketing-sync
Jun 16, 2026
Merged

Sync release docs and marketing#3
austin-thesing merged 3 commits into
mainfrom
release/docs-marketing-sync

Conversation

@austin-thesing

@austin-thesing austin-thesing commented Jun 16, 2026

Copy link
Copy Markdown
Member

Summary

  • Update README, changelog, provider/config/CLI docs, and keyboard shortcut docs for the refreshed provider/model surface.
  • Refresh website schema metadata, installation runtime requirements, hero demo model, and provider marketing copy.
  • Align internal schema docs with the v0.2.22 release prep metadata.

Test plan

  • npm run build (website)

Notes

  • This docs PR describes the runtime model refresh and dependency release prep, so it should merge after the registry and dependency PRs.

Note

Update docs and website to reflect v0.2.22 release with new providers and default model

  • Updates README, website docs, and structured data to reflect the v0.2.22 release, changing the default model from minimax-m2.5-free to deepseek-v4-flash-free across all examples and config snippets.
  • Adds documentation for three new providers: Vercel AI Gateway, Cloudflare AI Gateway, and Cloudflare Workers AI, including environment variables and CLI option examples.
  • Updates GitHub URLs and repository references from designxdevelop to austin-thesing across the website, schema files, and homepage.
  • Bumps the Bun prerequisite from v1.0+ to v1.3.14+ in installation docs and JSON-LD schema requirements.

Macroscope summarized 450cd8d.

Summary by CodeRabbit

  • Documentation
    • Expanded provider and model documentation to cover Vercel AI Gateway, Cloudflare AI Gateway, Workers AI, and custom OpenAI-compatible endpoints.
    • Refreshed model catalogs and recommendations, including switching the default model to deepseek-v4-flash-free.
    • Updated setup/config guidance with new gateway-related environment variables and configuration fields.
    • Refreshed CLI provider option and switching examples, plus keyboard shortcut provider lists.
    • Updated website schema, homepage metadata, and added the v0.2.22 release notes entry (including routing/model registry refresh details).

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation-only update for v0.2.22: adds Vercel AI Gateway, Cloudflare AI Gateway, Workers AI, and custom provider support across all reference docs; refreshes OpenCode Zen and OpenRouter model catalogs with new model IDs and changes the default model to deepseek-v4-flash-free; updates repository URLs from designxdevelop to austin-thesing and bumps version/runtime metadata; adds a v0.2.22 changelog entry.

Changes

v0.2.22 Documentation Release

Layer / File(s) Summary
Repository identity and version metadata bump
website/src/content/docs/getting-started/installation.mdx, website/src/content/docs/index.mdx, website/src/components/TransformHero.astro, website/src/pages/index.astro, website/src/components/Schema.astro, website/SCHEMA-IMPLEMENTATION.md, website/SCHEMA-SUMMARY.md, website/SCHEMA-VALIDATION.md, website/TEST-SCHEMA.md
Replaces all designxdevelop/magic-shell GitHub URLs with austin-thesing/magic-shell, bumps softwareVersion from 0.2.14 to 0.2.22, and changes runtime requirement from Node.js 18+ to Bun 1.3.14+ across schema docs, installation prerequisites, footer links, and website components.
New provider support: Cloudflare, Vercel AI Gateway, Workers AI, Custom
README.md, website/src/content/docs/reference/cli-options.mdx, website/src/content/docs/reference/config-file.mdx, website/src/content/docs/getting-started/configuration.mdx, website/src/content/docs/reference/keyboard-shortcuts.mdx, website/src/components/Schema.astro, website/src/components/FAQSchema.astro, website/src/content/docs/index.mdx, website/src/pages/index.astro
Adds vercel-ai-gateway, cloudflare-ai-gateway, workers-ai, and custom provider identifiers to the CLI --provider option, config-file provider table, setup guide wizard, and keyboard shortcut reference. Extends env-var documentation with Cloudflare-specific variables (cloudflareAccountId, cloudflareAiGatewayId, token/account/gateway entries). Updates FAQ, HowTo schema, and hero provider descriptions to reflect the broader set.
Model catalog refresh and default model update
README.md, website/src/content/docs/features/providers.mdx, website/src/content/docs/getting-started/configuration.mdx, website/src/content/docs/reference/config-file.mdx, website/src/components/TransformHero.astro
Replaces OpenCode Zen free-model list (now includes deepseek-v4-flash-free, mimo-v2.5-free, north-mini-code-free, nemotron-3-ultra-free) and refreshes premium and OpenRouter model tables (Anthropic Opus updated to claude-opus-4-8, new Moonshot/Z.ai/MiniMax entries). Changes default model from minimax-m2.5-free to deepseek-v4-flash-free in all config examples, model recommendation tables, and the TUI hero demo display.
v0.2.22 changelog and release notes
website/src/content/docs/reference/changelog.mdx, README.md
Adds the v0.2.22 changelog section (June 16, 2026) covering updated Zen free-model lineup, OpenRouter open-source highlights, Qwen routing change to Zen's Messages endpoint, default model update, and doc/lockfile refresh notes. Adds a corresponding Version History table row and README release notes entry.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main purpose of the PR—synchronizing documentation and marketing materials for the v0.2.22 release across README, website, configuration, and CLI references.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/docs-marketing-sync

Comment @coderabbitai help to get the list of available commands and usage tips.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6728fa9f74

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

| `hy3-preview-free` | Hy3 preview model |
| `nemotron-3-super-free` | NVIDIA Nemotron free trial model |
| `trinity-large-preview-free` | Trinity large preview model |
| `deepseek-v4-flash-free` | DeepSeek's free fast open-source model (default) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use only registered Zen model IDs in the docs

This table now tells users to use deepseek-v4-flash-free as the default, but the current registry does not contain that ID: OPENCODE_ZEN_MODELS still starts with minimax-m2.5-free, and DEFAULT_CONFIG.defaultModel is still minimax-m2.5-free. With this docs state, following msh --model deepseek-v4-flash-free hits the CLI's unknown-model path instead of selecting the documented default.

Useful? React with 👍 / 👎.

|--------|-------------|
| `--setup` | Run the setup wizard for API key configuration |
| `--provider <name>` | Set AI provider (`opencode-zen` or `openrouter`) |
| `--provider <name>` | Set AI provider (`opencode-zen`, `openrouter`, `vercel-ai-gateway`, `cloudflare-ai-gateway`, `workers-ai`, or `custom`) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove custom from the --provider documentation

The CLI docs now advertise msh --provider custom, but the handler for --provider only accepts opencode-zen, openrouter, vercel-ai-gateway, cloudflare-ai-gateway, and workers-ai; custom is only reached by adding/selecting a custom model. Users following this option will get the unknown-provider error instead of switching to custom endpoints.

Useful? React with 👍 / 👎.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 588-590: Add a blank line between the release heading "### v0.2.22
- Model Catalog and Release Prep" and the bulleted list items that follow it to
comply with markdown linting rule MD022, which requires a blank line after
headings. Insert an empty line after the heading line to separate it from the
first bullet point starting with "Refreshed OpenCode Zen".

In `@website/src/components/Schema.astro`:
- Around line 27-31: Update the founder.url and author.url fields in the
Schema.astro file to point to the author's GitHub profile instead of the
repository. For the founder object at lines 27-31, change the url from the full
repository path (ending in /magic-shell) to just the author's profile path.
Apply the same change to the author.url fields mentioned at lines 71-75 and
209-213. Keep the repository URL in codeRepository or sameAs fields as
appropriate for the schema type.

In `@website/src/content/docs/getting-started/installation.mdx`:
- Around line 26-30: The package.json file has outdated Bun version constraints
that conflict with the documented prerequisites. Update the package.json file by
changing the "packageManager" field from "bun@1.3.9" to "bun@1.3.14" and the
"bun" field from ">=1.3.9" to ">=1.3.14" to align with the Bun 1.3.14+
requirement specified in the installation documentation and other website files
like Schema.astro.

In `@website/src/content/docs/reference/cli-options.mdx`:
- Line 28: The documentation table for the `--provider` flag at line 28 in
website/src/content/docs/reference/cli-options.mdx includes `custom` as a valid
option, but this provider is not included in the CLI validation allowlist in
src/index.ts. Remove `custom` from the provider options list in the
documentation table to match the actual supported providers (opencode-zen,
openrouter, vercel-ai-gateway, cloudflare-ai-gateway, and workers-ai only).

In `@website/src/content/docs/reference/config-file.mdx`:
- Line 21: The documentation in config-file.mdx incorrectly states the default
model as deepseek-v4-flash-free on lines 21, 62, 252, and 264, but the actual
runtime default in src/lib/config.ts initializes DEFAULT_CONFIG.defaultModel as
minimax-m2.5-free. Update all four occurrences of deepseek-v4-flash-free in the
config-file.mdx documentation to minimax-m2.5-free to match the actual
DEFAULT_CONFIG.defaultModel value.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c36fbe27-5b95-4394-88d7-578ecc13fb71

📥 Commits

Reviewing files that changed from the base of the PR and between f45f9c8 and 6728fa9.

📒 Files selected for processing (17)
  • README.md
  • website/SCHEMA-IMPLEMENTATION.md
  • website/SCHEMA-SUMMARY.md
  • website/SCHEMA-VALIDATION.md
  • website/TEST-SCHEMA.md
  • website/src/components/FAQSchema.astro
  • website/src/components/Schema.astro
  • website/src/components/TransformHero.astro
  • website/src/content/docs/features/providers.mdx
  • website/src/content/docs/getting-started/configuration.mdx
  • website/src/content/docs/getting-started/installation.mdx
  • website/src/content/docs/index.mdx
  • website/src/content/docs/reference/changelog.mdx
  • website/src/content/docs/reference/cli-options.mdx
  • website/src/content/docs/reference/config-file.mdx
  • website/src/content/docs/reference/keyboard-shortcuts.mdx
  • website/src/pages/index.astro

Comment thread README.md
Comment thread website/src/components/Schema.astro
Comment thread website/src/content/docs/getting-started/installation.mdx
Comment thread website/src/content/docs/reference/cli-options.mdx Outdated
Comment thread website/src/content/docs/reference/config-file.mdx

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

45-45: ⚠️ Potential issue | 🟡 Minor

Update README.md line 45 to reflect Bun v1.3.14+

README.md still specifies Bun v1.3.9 or higher while other documentation files in this release (installation.mdx, Schema.astro) reference v1.3.14 or higher. Update this prerequisite to match the current baseline.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 45, The Prerequisite line in README.md specifies an
outdated Bun runtime version requirement of v1.3.9, which is inconsistent with
the v1.3.14 or higher baseline referenced in other documentation files like
installation.mdx and Schema.astro. Update the version number in the Bun
prerequisite statement from v1.3.9 to v1.3.14 to ensure consistency across all
documentation and reflect the current minimum supported version.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@README.md`:
- Line 45: The Prerequisite line in README.md specifies an outdated Bun runtime
version requirement of v1.3.9, which is inconsistent with the v1.3.14 or higher
baseline referenced in other documentation files like installation.mdx and
Schema.astro. Update the version number in the Bun prerequisite statement from
v1.3.9 to v1.3.14 to ensure consistency across all documentation and reflect the
current minimum supported version.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 02a0ae1b-71c4-494e-8848-1b0fb33ba419

📥 Commits

Reviewing files that changed from the base of the PR and between 6728fa9 and 450cd8d.

📒 Files selected for processing (3)
  • README.md
  • website/src/components/Schema.astro
  • website/src/content/docs/reference/cli-options.mdx

@austin-thesing
austin-thesing merged commit d245798 into main Jun 16, 2026
6 checks passed
@austin-thesing
austin-thesing deleted the release/docs-marketing-sync branch June 23, 2026 07:06
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