Skip to content

docs: fix public install guidance#169

Merged
simongonzalezdc merged 2 commits into
mainfrom
fix-public-install-docs
Jun 4, 2026
Merged

docs: fix public install guidance#169
simongonzalezdc merged 2 commits into
mainfrom
fix-public-install-docs

Conversation

@simongonzalezdc

@simongonzalezdc simongonzalezdc commented Jun 4, 2026

Copy link
Copy Markdown
Member

Summary

  • make the top-level Quick Start lead with the released MCP tarball config instead of source-only setup
  • mark the browser demo as a source-checkout workflow
  • update CLI package examples to use the installed dialectos binary
  • add regression coverage so public docs keep pointing users to release tarballs first

Verification

  • node --test docs/__tests__/public-claims.test.mjs
  • node --test docs/__tests__/*.test.mjs scripts/__tests__/*.test.mjs
  • verified GitHub release v0.3.0 includes dialectos-mcp-0.3.0.tgz and dialectos-cli-0.3.0.tgz

View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 80be798a-844d-443a-a724-d8679813e376

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 fix-public-install-docs

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 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: 2bae5aae49

ℹ️ 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".

Comment thread packages/cli/README.md Outdated
@simongonzalezdc simongonzalezdc enabled auto-merge (squash) June 4, 2026 19:40
@simongonzalezdc simongonzalezdc merged commit 44ed6b6 into main Jun 4, 2026
9 checks passed
@simongonzalezdc simongonzalezdc deleted the fix-public-install-docs branch June 4, 2026 19:41
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