Skip to content

Correct README trust boundaries and proof#41

Merged
JamesMaki merged 2 commits into
masterfrom
docs/oss-ready-readme-current
Jul 22, 2026
Merged

Correct README trust boundaries and proof#41
JamesMaki merged 2 commits into
masterfrom
docs/oss-ready-readme-current

Conversation

@laulpogan

@laulpogan laulpogan commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • correct the direct-edit, promotion, and audit boundaries against current source
  • replace stale visual proof with recorded terminal evidence from the current tutorial
  • narrow the first-run fetch to the document-skill source used by the demo
  • make the primary user, first-value signal, and deployment boundary explicit

This follows the revert in #40 and does not restore the README from #39.

Scope

  • README.md only

Verification

  • CodeScene pre-commit and branch-level quality gates passed
  • OSS Ready evidence, local target, and asset checks passed
  • docker compose config --quiet passed
  • recorded output matches docs/tutorial.md at the current base revision
  • full local Docker execution remained unavailable because of the host Docker storage and daemon fault; PR CI is the execution gate

Summary by CodeRabbit

  • Documentation
    • Reorganized and clarified the README’s introduction, system guarantees, deployment model, and project status/support information.
    • Refreshed the Quickstart with updated prerequisites (including Docker Compose version), required local ports, narrower skill-fetching instructions, and improved “successful run” guidance.
    • Tightened the “How it works” “Govern” description to better reflect evidence-gated approval and snapshotted, recoverable promotion behavior.

Replace stale visual proof and overbroad guarantees with current source-backed behavior, recorded terminal evidence, and a narrower first-run path.
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5d5746e0-05d9-491b-a225-d44012f917da

📥 Commits

Reviewing files that changed from the base of the PR and between 260c3d9 and 71176b4.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md was reorganized to clarify Ingot’s controls, deployment model, quickstart flow, governance scope, recorded trace behavior, and project support policies.

Changes

README documentation refresh

Layer / File(s) Summary
Overview, deployment, and quickstart guidance
README.md
The introduction, control guarantees, deployment model, prerequisites, skill-fetching steps, and recorded-run explanation were rewritten.
Governance and support documentation
README.md
Governance language now focuses on optimizer-generated challengers and human promotion, while project support channels and security-fix scope are documented.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README update around trust boundaries and recorded proof evidence.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/oss-ready-readme-current

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

@JamesMaki
JamesMaki merged commit 1fb1f43 into master Jul 22, 2026
1 of 2 checks passed
@JamesMaki
JamesMaki deleted the docs/oss-ready-readme-current branch July 22, 2026 06:22
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