Skip to content

docs: expand motivation section in README#83

Merged
robbycochran merged 2 commits into
mainfrom
rc-readme-why-section
Jun 18, 2026
Merged

docs: expand motivation section in README#83
robbycochran merged 2 commits into
mainfrom
rc-readme-why-section

Conversation

@robbycochran

@robbycochran robbycochran commented Jun 18, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrites the "Why this exists" section to better articulate the problem and design constraints
  • Adds the CI-tested harness insight: if the developer harness isn't live-tested in CI, the developer experience can't be maintained as upstream dependencies change
  • Adds the local-to-automated path: same YAML config moves from laptop to OCP by changing one field

Changes

Expanded from 3 paragraphs to 5 in the "Why this exists" section. No other files changed.

Summary by CodeRabbit

  • Documentation
    • Clarified project purpose and architecture, explaining how the harness bridges interactive local development with automated CI validation workflows across multiple deployment targets using unified configuration.

Rewrite the motivation section to articulate the core design
constraint: a developer harness that is not continuously tested in CI
will silently break as upstream dependencies change. Add the
local-to-automated path description showing how the same YAML config
moves from laptop to OCP by changing one field.
@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: bb87d3a0-d0ef-4e59-95e1-5017a20f0cef

📥 Commits

Reviewing files that changed from the base of the PR and between 541b5b7 and 374d5a9.

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

Walkthrough

The "Why this exists" section in README.md is expanded from 2 lines to 6 lines, adding explanation of OpenShell's runtime role versus the harness workflow layer, a CI validation design constraint, lifecycle coverage across targets, and the --attach to --task workflow transition.

Changes

README Documentation Update

Layer / File(s) Summary
Expanded "Why this exists" section
README.md
Replaces a brief two-line description with six lines that distinguish OpenShell's secure sandbox runtime from the harness workflow layer, state CI validation as a core design constraint, describe harness-openshell lifecycle coverage across multiple targets, and document the transition from --attach local runs to --task headless runs using the same harness YAML artifact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rc-readme-why-section

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

@robbycochran robbycochran merged commit ac8bccf into main Jun 18, 2026
6 of 7 checks passed
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