[docs] : docs for source of truth - #4499
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (10)
✅ Files skipped from review due to trivial changes (10)
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds a new ChangesSource of Truth & Reconciliation Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 4❌ Failed checks (3 warnings, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Confidence Score: 4/5Documentation-only change; the one incorrect Helm field name left in complexity-router.mdx would cause users to silently set a no-op value. The Helm field correction in helm/governance.mdx was not applied to the same stale reference in docs/features/governance/complexity-router.mdx, where bifrost.governance.sourceOfTruth remains. A user following the complexity-router guide and copying that snippet will set a field the chart does not recognise, with no effect on governance state. docs/features/governance/complexity-router.mdx — still references the old field name bifrost.governance.sourceOfTruth that was corrected elsewhere in this PR. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Bifrost startup] --> B{config.json present?}
B -- No --> C[Default SQLite store\nUI/API edits enabled]
B -- Yes --> D{config_store.enabled?}
D -- false --> E[File-only memory load\nUI config unavailable\nRestart required]
D -- true / omitted --> F{source_of_truth?}
F -- split default --> G[Hash-compare each entity\nUnchanged hash keep DB edits\nChanged hash apply file version\nDB-only rows preserved]
F -- config.json --> H[Present sections authoritative\nApplied even if hash matches\nMissing section DB rows untouched\nEmpty section prunes DB rows]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[Bifrost startup] --> B{config.json present?}
B -- No --> C[Default SQLite store\nUI/API edits enabled]
B -- Yes --> D{config_store.enabled?}
D -- false --> E[File-only memory load\nUI config unavailable\nRestart required]
D -- true / omitted --> F{source_of_truth?}
F -- split default --> G[Hash-compare each entity\nUnchanged hash keep DB edits\nChanged hash apply file version\nDB-only rows preserved]
F -- config.json --> H[Present sections authoritative\nApplied even if hash matches\nMissing section DB rows untouched\nEmpty section prunes DB rows]
Reviews (3): Last reviewed commit: "[docs] : docs for source of truth" | Re-trigger Greptile |
4604a6f to
8ae4dae
Compare
8ae4dae to
437c624
Compare
Merge activity
|

Summary
Briefly explain the purpose of this PR and the problem it solves.
Changes
Type of change
Affected areas
How to test
Describe the steps to validate this change. Include commands and expected outcomes.
If adding new configs or environment variables, document them here.
Screenshots/Recordings
If UI changes, add before/after screenshots or short clips.
Breaking changes
If yes, describe impact and migration instructions.
Related issues
Link related issues and discussions. Example: Closes #123
Security considerations
Note any security implications (auth, secrets, PII, sandboxing, etc.).
Checklist
docs/contributing/README.mdand followed the guidelines