Skip to content

docs: tighter value proposition, accuracy fixes, maintenance posture#11

Merged
mazze93 merged 2 commits into
mainfrom
claude/repo-docs-value-trust-dLqaj
Jun 1, 2026
Merged

docs: tighter value proposition, accuracy fixes, maintenance posture#11
mazze93 merged 2 commits into
mainfrom
claude/repo-docs-value-trust-dLqaj

Conversation

@mazze93

@mazze93 mazze93 commented May 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • README: Rewrites the opening with a concrete one-liner + who-it's-for, adds an explicit v0.3-experimental status block, replaces the six-section Design Principles bloat with a single table, removes the admin-only social preview instructions, adds a Maintenance Posture section (SLA, breaking-change policy, security link), and adds a Known Issues table with severity/target-version.
  • INSTALL.md: Fixes wrong prerequisites (macOS 12→13, Swift 5.7→5.8, Xcode 14→15), removes non-existent CLI flags (--status, --config, --feedback positive), clarifies that SPM produces executables not .app bundles, and replaces the incorrect config JSON with the actual default_config.json structure.
  • Both files: Fix CLI examples to use real flags (--feedback good|bad), real config JSON (uniform Beta priors, actual trigger keys), and link SECURITY.md from the README for a clear trust path.

Test plan

  • Read through README top-to-bottom as a new visitor — value prop lands in the first two sentences
  • All CLI examples in README and INSTALL.md are runnable against the actual binary
  • Prerequisites match CLAUDE.md (macOS 13+, Swift 5.8+)
  • Config JSON matches default_config.json in the repo root
  • SECURITY.md is reachable from the Maintenance Posture section
  • CI passes (file existence checks include README, INSTALL.md, SECURITY.md)

https://claude.ai/code/session_0193B19zr8PsbvJMphKxufw4


Generated by Claude Code

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • INSTALL.md is excluded by none and included by none
  • README.md is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: ebba266c-5b5f-410b-a951-11f8c52431c7

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 claude/repo-docs-value-trust-dLqaj

Comment @coderabbitai help to get the list of available commands and usage tips.

…sture

README.md
- Replace diffuse opening with concrete one-liner + who-it's-for statement
- Add explicit v0.3-experimental status block at the top
- Fix prerequisites (macOS 12/Swift 5.7 → macOS 13/Swift 5.8)
- Fix CLI examples to match actual flags (--feedback good|bad, remove fake --status/--config)
- Fix config JSON to match default_config.json (uniform Beta priors, real trigger keys)
- Remove admin-only social preview instructions
- Condense Design Principles from six verbose sections to one table
- Add Maintenance Posture section (SLA, breaking change policy, security link)
- Link SECURITY.md explicitly from README for trust path
- Add Known Issues table with severity and target version

INSTALL.md
- Fix prerequisites (macOS 13+, Xcode 15+, Swift 5.8+)
- Clarify SPM produces executables, not .app bundles (Xcode required for GUI bundle)
- Remove non-existent CLI flags (--status, --config, --feedback positive)
- Replace incorrect config JSON with actual default_config.json structure
- Add security link at bottom

https://claude.ai/code/session_0193B19zr8PsbvJMphKxufw4
The Programmatic usage example called `core.weights.tones/.intents/.domains`,
but SynapseCore exposes no `weights` property — both the CLI and the GUI
obtain weights via `core.loadOrCreateDefaultWeights()`. As written the
snippet does not compile. Source the weights explicitly, matching the
actual library surface.

Also corrects the description of OpenAIClient/AnthropicClient: they are
chat-completion adapters (sendPrompt), not embedders.

https://claude.ai/code/session_01BBeeaADak63VbvE7kuYw96
@mazze93 mazze93 force-pushed the claude/repo-docs-value-trust-dLqaj branch from d1f2254 to 6c72aa0 Compare May 30, 2026 03:44

mazze93 commented May 30, 2026

Copy link
Copy Markdown
Owner Author

Heads up: this PR is now docs-only again. The CLI fix that was briefly on this branch has been split into #14 (targets main), since it repairs a bug that lives in main rather than anything in these docs.

As a result, Build, test, and guardrails here will be red until #14 merges — this branch inherits the failing testExportAndImportAcceptUserFlagBeforeCommandFlag from main. Once #14 lands, rebasing this branch on main turns it green with no further changes.


Generated by Claude Code

@mazze93 mazze93 marked this pull request as ready for review May 30, 2026 03:49
@mazze93 mazze93 merged commit cc0b38a into main Jun 1, 2026
3 of 4 checks passed
@mazze93 mazze93 deleted the claude/repo-docs-value-trust-dLqaj branch June 1, 2026 09:53
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.

2 participants