docs: tighter value proposition, accuracy fixes, maintenance posture#11
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (2)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…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
d669b53 to
0c12e6a
Compare
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
d1f2254 to
6c72aa0
Compare
|
Heads up: this PR is now docs-only again. The CLI fix that was briefly on this branch has been split into #14 (targets As a result, Generated by Claude Code |
Summary
--status,--config,--feedback positive), clarifies that SPM produces executables not.appbundles, and replaces the incorrect config JSON with the actualdefault_config.jsonstructure.--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
default_config.jsonin the repo roothttps://claude.ai/code/session_0193B19zr8PsbvJMphKxufw4
Generated by Claude Code