Skip to content

docs(acp): update ACP README to reflect current architecture#18911

Open
soddygo wants to merge 6 commits intoanomalyco:devfrom
soddygo:dev
Open

docs(acp): update ACP README to reflect current architecture#18911
soddygo wants to merge 6 commits intoanomalyco:devfrom
soddygo:dev

Conversation

@soddygo
Copy link
Copy Markdown

@soddygo soddygo commented Mar 24, 2026

Issue for this PR

Closes #

Type of change

  • Bug fix
  • New feature
  • Refactor / code improvement
  • Documentation

What does this PR do?

Update the ACP README to reflect current code structure after refactoring in PR #3403.

The server.ts and client.ts files were removed in commit 98d51dd, but the README was not updated accordingly, causing documentation to be out of sync with the actual code.

Changes:

  • Remove references to deleted server.ts and client.ts files
  • Add Server Startup section pointing to cli/cmd/acp.ts
  • Update Permission Handling section to match current implementation
  • Remove outdated Programmatic usage example (ACPServer.start())
  • Fix Clean Architecture section to accurately describe components

How did you verify your code works?

  • Verified all file references in README match actual files in packages/opencode/src/acp/
  • Verified cli/cmd/acp.ts exists and contains the server startup logic
  • Checked git history to confirm server.ts and client.ts were deleted in commit 98d51dd

Screenshots / recordings

N/A - Documentation change only

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

soddygo added 2 commits March 24, 2026 17:53
- Remove references to deleted server.ts and client.ts
- Add Server Startup section pointing to cli/cmd/acp.ts
- Update Permission Handling section to match current implementation
- Remove outdated Programmatic usage example
- Fix Clean Architecture section to accurately describe components
@github-actions github-actions Bot added needs:compliance This means the issue will auto-close after 2 hours. and removed needs:compliance This means the issue will auto-close after 2 hours. labels Mar 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Thanks for updating your PR! It now meets our contributing guidelines. 👍

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