Skip to content

docs(readme): add feature overview matrix, trim Quick Start - #318

Merged
jeff-r2026 merged 1 commit into
mainfrom
worktree-readme-overview-table
Aug 24, 2026
Merged

docs(readme): add feature overview matrix, trim Quick Start#318
jeff-r2026 merged 1 commit into
mainfrom
worktree-readme-overview-table

Conversation

@jeff-r2026

Copy link
Copy Markdown
Collaborator

What

Add a Feature Overview table to the README (both languages) and trim redundant Quick Start prose.

Overview matrix

Agents (rows) × resources (columns), rendered as an HTML two-level header table grouping columns into three areas:

  • Harness — skills · rules · docs · env · agents · hooks · mcp
  • Knowledge Base — learnings · codebase · teamwiki
  • Governance — usage · sessions · dashboard

Covers 8 agents (Claude Code, Codex, Cursor, CodeBuddy, OpenCode, WorkBuddy, OpenClaw, Hermes). ✓/— cells are sourced from src/types.ts toolPaths (per-tool support) and src/builtin-hooks.ts (governance = tools with dispatch hooks).

A Git providers line lists the supported hosts: GitHub · GitLab (incl. self-hosted) · CNB · TGit · any private/self-hosted service (from src/providers/registry.ts).

Trims

  • Single-repo mode: removed the 5 detail bullets and the trailing commit-summary sentence
  • Removed the --inherit-user-scope layered-setup example and the solo-use note
  • Removed the recall coverage/ranking detail paragraphs
  • Removed the Global options line

Docs sync

  • docs/usage-guide.{md,zh-CN.md}: added GitLab + private/self-hosted to the repo-creation line and moved TGit later in provider lists
  • README.md / README.zh-CN.md kept in sync

Test Plan

  • Both README tables render with matching column counts (13 data cells/row, colspan 7+3+3)
  • No stray garbage characters or escaped pipes
  • Provider lists consistent across README + usage-guide (TGit last among named hosts)
  • Bilingual docs verified in sync

Docs-only change; no code affected.

- Add an Overview table (agents × resources) grouped into Harness,
  Knowledge Base, and Governance, rendered as an HTML two-level header
- List supported Git providers (GitHub / GitLab incl. self-hosted / CNB /
  TGit / any private/self-hosted) and add GitLab to usage-guide
- Trim redundant Quick Start prose: single-repo bullets, --inherit-user-scope
  example, solo-use note, recall coverage/ranking detail, global-options line
- Keep README.md / README.zh-CN.md in sync
@jeff-r2026
jeff-r2026 merged commit 0bbedfa into main Aug 24, 2026
7 checks passed
@jeff-r2026
jeff-r2026 deleted the worktree-readme-overview-table branch August 26, 2026 06:59
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