Skip to content

feat: rewrite readme and claude.md#47

Merged
sirily11 merged 1 commit into
mainfrom
docs
May 22, 2026
Merged

feat: rewrite readme and claude.md#47
sirily11 merged 1 commit into
mainfrom
docs

Conversation

@sirily11
Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings May 22, 2026 06:37
@sirily11 sirily11 enabled auto-merge (squash) May 22, 2026 06:37
@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
rxcode Ready Ready Preview, Comment May 22, 2026 6:38am

Request Review

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR refreshes the project’s public-facing and agent-facing documentation by rewriting the README, consolidating coding-agent guidance into AGENTS.md, and making CLAUDE.md a pointer to the canonical guidance.

Changes:

  • Rewrites README.md to reflect the current product scope (multi-agent runtimes, worktrees, search, mobile sync, briefings) and updates screenshots/sections.
  • Replaces the detailed CLAUDE.md content with a delegation to AGENTS.md.
  • Expands AGENTS.md with updated architecture notes, repo layout, build/test commands, and implementation/testing guidelines.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
README.md Rewritten product overview, feature breakdown, screenshots, requirements, and build instructions.
CLAUDE.md Delegates Claude Code guidance to the canonical AGENTS.md.
AGENTS.md Establishes a single canonical agent guidance doc with updated architecture, layout, and build/test expectations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md
Comment on lines +13 to +15
- Write code comments, log messages, commit messages, PR descriptions, documentation, and user-facing text in English.
- Keep documentation factual and current. Prefer removing duplicated guidance over maintaining the same instructions in multiple files.
- Preserve user changes. Do not revert unrelated local edits unless the user explicitly asks for that.
Comment thread AGENTS.md
- macOS app deployment target: macOS 26.0+
- Swift tools version: 6.2
- Main app bundle ID: `com.rxlab.RxCode`
- App-level dependencies: SwiftTerm and Sparkle
Comment thread README.md
Comment on lines +117 to +124
## Requirements

- macOS 26.0 or later
- At least one supported agent runtime:
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code)
- Codex CLI
- An ACP-compatible client installed from Settings or configured externally
- Xcode with the Swift 6.2+ toolchain to build from source
@sirily11 sirily11 merged commit 3936219 into main May 22, 2026
14 checks passed
@sirily11 sirily11 deleted the docs branch May 22, 2026 06:48
@sirily11
Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 1.10.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants