Skip to content

docs: go-public README rewrite + CONTRIBUTING + publishing/npm story (#87) - #189

Merged
robercano-ghbot merged 1 commit into
mainfrom
feat/issue-87-go-public-docs
Jul 24, 2026
Merged

docs: go-public README rewrite + CONTRIBUTING + publishing/npm story (#87)#189
robercano-ghbot merged 1 commit into
mainfrom
feat/issue-87-go-public-docs

Conversation

@robercano-ghbot

Copy link
Copy Markdown
Collaborator

What

Go-public docs pass for issue #87. Makes the repo readable to a stranger before it flips public.

  • README.md — rewritten for an external reader: what reCode is (orchestrated multi-agent dev for Claude Code — PR loop, gates-as-code, worktree-isolated workers, cockpit), a verified 5-minute quickstart (plugin install → /orchestrator:setuparm-loop.sh), a cockpit serve-mode section, an "Installing / publishing" section documenting the supported plugin-marketplace install path and recording the npm-name situation (squatted-dead; scope-vs-dispute, decision pending).
  • CONTRIBUTING.md (new) — the self-hosted contribution model: backlog → owner-only planned two-label workflow, the scope → build → gate → reviewer-lens (correctness + tests, consensus all) → bot-PR pipeline, and an explicit "what NOT to touch" list (.claude/self/, @orchestrator-managed MANAGED templates, LICENSE, module boundaries).

Scope notes

  • LICENSE already landed as a0a4f9a (MIT) — untouched here.
  • Cockpit demo GIF/screenshot is intentionally a <!-- TODO(#87) --> placeholder — no agent can capture a screen recording; the section describes the demo and the launch command in words rather than fabricating an image link.
  • Hygiene sweep — the bot's prior 2026-07-23 sweep already covered it; an independent spot-check (grep tracked files for /home/rcano + token patterns; confirm .gitignore covers .claude/state/, settings.local.json, editor dirs, .env*) found no new gap, so .gitignore is unchanged.
  • Repo-visibility flip is owner-only and out of scope for this PR.

Validation

  • Gates (self-adapter, GATES_FILE=.claude/self/gates.json): build / lint / test all green (test includes smoke-fanout.sh end-to-end).
  • Reviewer lenses: correctness (opus) APPROVE, tests (sonnet) APPROVE — consensus all. Command names, doc paths, and relative links verified real against docs/, .claude/commands/, plugin.json, and package.json.

Closes #87

🤖 Generated with Claude Code

Rewrite the root README for a stranger who has never seen the project:
what reCode is, the actual supported quickstart (plugin install ->
/orchestrator:setup -> arm the loop, verified against docs/GETTING_STARTED.md
and .claude-plugin/plugin.json's real command names), and a cockpit serve-mode
section with an explicit pending-screenshot placeholder marker instead of a
fabricated image link.

Add CONTRIBUTING.md documenting the self-hosted contribution model: the
backlog -> planned two-label approval workflow, the scope -> build -> gate ->
review -> PR -> merge pipeline, and what external contributors should not
touch (.claude/self/, MANAGED template files, LICENSE, module boundaries).

Record the npm-name situation (squatted-dead, scope vs. dispute undecided)
in README's new Installing/publishing section so the open decision is
written down where a contributor can find it.

Hygiene: spot-checked (grep for /home/rcano paths and token patterns in
tracked files, .gitignore coverage of .claude/state/, settings.local.json,
.env*, editor dirs) and confirmed clean, consistent with the bot's prior
2026-07-23 sweep. No .gitignore changes needed.
@robercano-ghbot robercano-ghbot added the needs-human Loop escalated: attempt budget exhausted, manual triage required label Jul 24, 2026
@robercano-ghbot

Copy link
Copy Markdown
Collaborator Author

docs: go-public README rewrite + CONTRIBUTING + publishing/npm story (#87) (not yet reviewed)

@robercano-ghbot robercano-ghbot removed the needs-human Loop escalated: attempt budget exhausted, manual triage required label Jul 24, 2026
@robercano-ghbot
robercano-ghbot merged commit 6867ed5 into main Jul 24, 2026
9 checks passed
@robercano-ghbot
robercano-ghbot deleted the feat/issue-87-go-public-docs branch July 24, 2026 13:48
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.

Go-public checklist: README with cockpit demo, LICENSE, contribution notes, publishing story

2 participants