Skip to content

docs(readme): add Why OCP, comparison table, governance section - #53

Merged
dtzp555-max merged 1 commit into
mainfrom
chore/readme-positioning-polish
May 4, 2026
Merged

docs(readme): add Why OCP, comparison table, governance section#53
dtzp555-max merged 1 commit into
mainfrom
chore/readme-positioning-polish

Conversation

@dtzp555-max

Copy link
Copy Markdown
Owner

Summary

README positioning polish to better convert visitor clones into stars. Three additive sections, no content removed, no anchors broken.

  1. "Why OCP?" section near the top (after the headline pitch, before "Supported Tools"). Six differentiator bullets with evidence links:

  2. "Comparison" subsection — honest table vs claude-code-router and anthropic-proxy. Acknowledges CCR has the larger ecosystem; positions OCP as cli.js-aligned + subscription-multiplexing focused. Plain-English paragraph below the table tells the reader which one to pick. States "single-maintainer + LLM-assisted, currently pre-1.0" honestly.

  3. "Governance" section near the bottom (before License) — consolidates links to ALIGNMENT.md, AGENTS.md, alignment.yml workflow, models.json, and the ADR directory. Previously these were scattered or only mentioned inline.

Diff

  • 1 file changed, +43 -0
  • README.md only; no other repo files touched

Why this PR (vs. shipping each section separately)

All three sections together form a single editorial layer ("repositioning the README to lead with differentiation"). Iron Rule 11's "minimum reviewable unit" treats them as one layer × one severity × one file. Splitting would create three trivial PRs that all need the same review pass.

Tao review checklist (please tick before merge)

Type

  • Documentation only

Claude Code Alignment Evidence

  • No cli.js citation required — README only, no server.mjs change.

Reviewer checklist (Iron Rule 10)

  • N/A — no server.mjs change
  • CI alignment.yml passes (no server.mjs touched, should pass trivially)
  • I am not the commit author of any commit in this PR

Privacy self-check (for public repos)

  • No real names, nicknames, or handles. References use role-based terms ("the maintainer").
  • No literal personal paths.
  • No personal machine hostnames.
  • No personal email addresses.

User-visible change self-check (铁律第五律 5.3)

  • User-visible change → README updated (this is the README change itself)

🤖 Generated with Claude Code

Adds three positioning sections to make the README convert clones-to-stars
better:

1. "Why OCP?" near the top — 6 differentiator bullets with evidence links
   (SSE heartbeat / ALIGNMENT.md / models.json SPOT / multi-key /
   per-key quota / ocp-connect).
2. "Comparison" subsection — honest table vs claude-code-router and
   anthropic-proxy. Acknowledges CCR's larger ecosystem; positions OCP
   as cli.js-aligned + subscription-multiplexing focused.
3. "Governance" section near the bottom — links to ALIGNMENT.md, AGENTS.md,
   ADRs, alignment.yml. Consolidates the governance-link surface in one
   place rather than scattered.

Net diff +43 -0. No content removed. No anchors broken. No code changes.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@dtzp555-max
dtzp555-max merged commit e4b010a into main May 4, 2026
@dtzp555-max
dtzp555-max deleted the chore/readme-positioning-polish branch May 4, 2026 23:44
dtzp555-max added a commit that referenced this pull request May 4, 2026
…iles, ADR index, ship-archive) (#59)

Multiple documentation polish items rolled into one PR (one layer:
"docs alignment with current state").

### README.md

- **Uninstall section** added between Server Setup and Client Setup
  (was missing — `node uninstall.mjs` exists but went undocumented).
- **OpenClaw definition** added as a footnote on first README mention
  (the architecture diagram and Supported Tools table both reference
  OpenClaw without ever defining it).
- **Repository Layout section** added before Security — table of
  top-level files (server.mjs, setup.mjs, uninstall.mjs, keys.mjs,
  models.json, ocp/ocp-connect, dashboard.html, scripts/, .claude/skills/,
  ocp-plugin/, docs/adr/, ALIGNMENT.md, AGENTS.md, CLAUDE.md) so a new
  contributor knows what each file does.
- **LICENSE link** added to the License section footer.

### docs/adr/README.md (new)

- Index of the three published ADRs (0002, 0003, 0004) with a one-line
  description each.
- Explains the `0001` placeholder (early internal proposal that was
  superseded; numbering deliberately starts at `0002`).
- Guidance on when to write a new ADR vs. when a commit message suffices.

### Spec/plan housekeeping

- `specs/.gitkeep` removed (the empty `specs/` placeholder confused the
  picture; canonical paths are `docs/superpowers/plans/` for active plans
  and `docs/superpowers/specs/` for long-lived design docs that other
  code references).
- Shipped plans moved to `docs/superpowers/plans/shipped/`:
  - `2026-04-10-lan-mode.md` (shipped: README LAN mode section)
  - `2026-04-25-47-sse-heartbeat-plan.md` (shipped: v3.12.0 per CHANGELOG)
- `2026-04-25-47-sse-heartbeat-design.md` left in `docs/superpowers/specs/`
  unchanged because both `server.mjs:565` and `CHANGELOG.md:7` link to
  that exact path; moving it would require a `server.mjs` edit, which
  needs `cli.js` citation per ALIGNMENT.md Rule 1.

### AGENTS.md

- Updated "Key files to know" to add `docs/adr/README.md`,
  `docs/superpowers/plans/`, and `memory/constitution.md`.
- Note explaining `memory/constitution.md` is spec-kit's standard
  location, distinct from `~/.cc-rules/memory/` and `ALIGNMENT.md`.
- Updated "Handoff expectations" item 5 from `docs/superpowers/specs/*/tasks.md`
  (which never matched anything — there were no `tasks.md` files there)
  to `docs/superpowers/plans/` (excluding `shipped/`).

### Coordination with PR #53

PR #53 is open and adds "Why OCP?", "Comparison", and "Governance"
sections to README. This PR deliberately avoids those areas — only edits
the Supported Tools table footnote, inserts Uninstall before Client Setup,
inserts Repository Layout before Security, and updates the License footer.
No expected merge conflict.

Refs: audit findings M6, M8, M9, M11, L2, L3, L6.

Co-authored-by: dtzp555 <dtzp555@gmail.com>
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