Skip to content

docs: rewrite README for first success#2

Merged
JNHFlow21 merged 1 commit into
mainfrom
codex/rewrite-readme
Jul 23, 2026
Merged

docs: rewrite README for first success#2
JNHFlow21 merged 1 commit into
mainfrom
codex/rewrite-readme

Conversation

@JNHFlow21

Copy link
Copy Markdown
Owner

Summary

  • rewrite the README around one clear promise: define each MCP once and store each credential once
  • move the verified source-install path and observable first success ahead of the feature catalog
  • document local credential boundaries, supported integrations, and alpha limitations without presenting roadmap work as shipped
  • update the docs regression test to preserve the new quick-start-before-capabilities structure

Verification

  • PYTHONPATH=src python3 -m unittest discover -s tests -v (72 passed)
  • PYTHONPATH=src python3 -m unittest discover -s tests/integration -v (1 passed)
  • isolated pipx install from a fresh GitHub clone; agent-switch --version returned 0.2.0
  • swift build --package-path macos-app/AgentSwitch
  • Xcode Release build with signing disabled
  • python3 scripts/privacy_scan.py
  • README strict audit: 100/100, no findings
  • all relative README links resolved

@JNHFlow21
JNHFlow21 merged commit 29187fb into main Jul 23, 2026
6 checks passed
@JNHFlow21
JNHFlow21 deleted the codex/rewrite-readme branch July 23, 2026 06:30

@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: c5ef738c92

ℹ️ 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 README.md
Comment on lines +293 to +295
The native app lives in [`macos-app/AgentSwitch`](macos-app/AgentSwitch) and
targets macOS 14+. See [CONTRIBUTING.md](CONTRIBUTING.md) for the complete test
and privacy gate.

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 Document the source-launch override

The development section no longer explains how to make a locally built app use the checkout. After following the shown venv setup, launching the app against source will not pick that environment: AgentSwitchService only enables source execution when AGENT_SWITCH_DEV_ROOT is set; otherwise it looks for an installed CLI and then invokes a system Python without the checkout's PYTHONPATH. CONTRIBUTING.md does not supply this missing runtime instruction, so developers cannot reliably exercise their source changes in the native app.

Useful? React with 👍 / 👎.

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