Skip to content

docs: audit and fix READMEs across the repo#4452

Merged
ashleeradka merged 1 commit into
mainfrom
ashleeradka/docs-readme-audit
Feb 18, 2026
Merged

docs: audit and fix READMEs across the repo#4452
ashleeradka merged 1 commit into
mainfrom
ashleeradka/docs-readme-audit

Conversation

@ashleeradka
Copy link
Copy Markdown
Contributor

@ashleeradka ashleeradka commented Feb 18, 2026

Summary

  • Root README: Updated architecture section from 2 to 3 components (added native clients with iOS/macOS description), expanded repo structure tree to include benchmarking/, .claude/, fixed clients/ label from "Desktop clients" to "Native clients", removed dead assistant/README.md link
  • clients/README.md: Removed stale PR number references ("PR 2", "PR 3") and the outdated "Migration from Single-Platform" section that referenced old PR Create VellumAssistantShared library and restructure for iOS support #1821
  • clients/ios/README.md: Standardized daemon startup command from src/daemon/main.ts to canonical src/index.ts daemon start (consistent with root and macOS READMEs)
  • clients/macos/README.md: Clarified iOS build options ("Build via Xcode (recommended) or xcodebuild"), removed inaccurate bun run dev claim, standardized to single canonical daemon startup command

🤖 Generated with Claude Code


Open with Devin

- Root README: add iOS to architecture description, update repo structure
  tree (add benchmarking/, .claude/, fix clients/ description), remove
  dead assistant/README.md link
- clients/README.md: remove stale PR number references and outdated
  "Migration from Single-Platform" section
- clients/ios/README.md: standardize daemon startup to canonical CLI
  entry point (src/index.ts daemon start)
- clients/macos/README.md: clarify iOS build options (Xcode recommended),
  standardize daemon startup command, remove inaccurate bun run dev claim

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ashleeradka ashleeradka merged commit 345f9d0 into main Feb 18, 2026
1 check passed
@ashleeradka ashleeradka deleted the ashleeradka/docs-readme-audit branch February 18, 2026 13:30
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

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