Skip to content

docs: rebuild README for public release - #20

Merged
khakisketch merged 1 commit into
mainfrom
docs/public-readme-20261109
Nov 9, 2026
Merged

khakisketch merged 1 commit into
mainfrom
docs/public-readme-20261109

Conversation

@khakisketch

Copy link
Copy Markdown
Owner

Summary

  • Rebuild README.md as an English-first public entry: hero, why it exists, architecture, key principles, quick start, typical usage, tooling, verification boundaries, documentation map and license.
  • Document the real installation path: back up config, merge global/AGENTS.md and global/opencode.jsonc manually, install skills project-locally, verify, revert. No fictional installer or automation.
  • Add CONTRIBUTING.md with scope, local checks and PR expectations.
  • Update the Korean docs index anchors and README description to match the new structure.
  • Update GitHub repository description and topics (admin permission confirmed).

Verification

  • node scripts/verify-harness.mjs --offline → 1/1 passed (5.5s)
  • All relative links in README, CONTRIBUTING and docs/README resolve
  • git diff --check clean

Public information and license

  • No credentials or real tokens found. ghp_a1b2c3d4e5f6 is a synthetic test fixture.
  • 127.0.0.1:17321 appears in historical validation/review records as a local gateway address; non-secret, kept without history rewrite.
  • Commit author identity uses a local hostname (ksi@KSIui-Macmini.local); owner may want to set a public identity.
  • Vendored Anthropic skills are Apache-2.0 with upstream LICENSE and SOURCE.md; the harness remains MIT.
  • SECURITY.md not added: GitHub private vulnerability reporting is disabled. No release or tag created.

Not changed

Four roles, delegation depth, permissions, model/provider config, Beads/Sleev operation, MCP servers and external services.

- Replace the Korean internal operations README with an English-first project entry: hero, why, architecture, key principles, quick start, usage, tooling, verification boundaries, docs map and license.

- Quick start documents the real manual-merge installation path (backup, AGENTS merge, opencode.jsonc merge, optional project-local skills, verification, revert). No fictional installer or automation is promised.

- Add CONTRIBUTING.md with scope, local checks and PR expectations. Note the Apache-2.0 license for vendored Anthropic skills and keep MIT for the harness.

- Update the Korean docs index anchors and README description to match the new structure.

Verified: node scripts/verify-harness.mjs --offline 1/1; relative links resolve; git diff --check clean.
@khakisketch
khakisketch merged commit a54f48e into main Nov 9, 2026
1 check passed
@khakisketch
khakisketch deleted the docs/public-readme-20261109 branch November 9, 2026 09:45
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