Skip to content

docs: rewrite README and docs/ for accuracy and voice; split README into guides - #458

Merged
fu351 merged 2 commits into
mainfrom
docs/rewrite-for-docs-site
Aug 25, 2026
Merged

docs: rewrite README and docs/ for accuracy and voice; split README into guides#458
fu351 merged 2 commits into
mainfrom
docs/rewrite-for-docs-site

Conversation

@fu351

@fu351 fu351 commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

What

A full accuracy + voice pass over the public docs, and the README split so it reads as a front door. These files are also the source the new documentation site (docs.trydoberman.dev, served from the landing project) renders from.

  • README.md 6,893 → 3,518 words. Keeps: why, quick start (agent table, install, setup), verify end-to-end, who it's for, roadmap link + the full Known limitations list, contributing, license. Deep sections moved out:
    • docs/TUNING.md (new): modes, enforcement dial, default role, prefs, tune, message-tone
    • docs/PLUGINS.md (new): custom guardrail + webhook audit sink via entry points
    • docs/RECOVERY.md (new): taint clear, tools approve, memory reset/prune, uninstall / uninstall-hooks
    • docs/TURN_GATE.md (new): the README turn-gate section plus the module map and invariants
  • docs/CLI.md: now covers all 37 commands/subcommands (the 2fa group, uninstall, message-tone, tools approve were undocumented); exit-code collision audit corrected to the real count (45); JSON-contract sections re-verified against cli/main.py and cli/doctor.py.
  • docs/REASON_CODES.md: header 56 → 57 (matches the enum); five raise-site columns corrected (secret_exfiltration, multi_step_exfil, confirmed_exfilhosthooks/hookio.py; correlated_trifecta, correlated_destructive_flowengine/correlator.py); redundant Value column dropped; plan-chip group names replaced with subsystem names.
  • docs/SETUP.md 3,618 → 2,815 words; the three README-linked anchors (Claude Code hooks, MCP proxy, OpenClaw) kept verbatim.
  • docs/RELEASING.md is now the one release doc (root RELEASING.md is a pointer); the sdist file list now matches pyproject.toml (tools/ was missing). CHANGELOG.md/SECURITY.md links updated to the new anchor location.
  • docs/audit_otel.md: failed POSTs are logged at warning, not debug (checked against otel_sink.py).
  • docs/PARITY.md prose only; tools/parity/generate_parity.py header strings updated so --check stays byte-identical.
  • docs/ADAPTER_GUIDE.md, adapters/openclaw/README.md, CONTRIBUTING.md, docs/BENCHMARKS.md: voice pass; every number and command kept or verified.

Ground truth for every command and flag was a full --help dump of every command from src/ at v0.18.1. No claim was kept that could not be traced to code or help text.

Ordering note (ADR 0080)

#447 (docs/CLI.md) and #414 (README.md, docs/SETUP.md) touch files rewritten here and are already conflicting with main. Whichever lands second needs its doc delta re-applied by hand; this PR is not merged by the session that opened it.

Test plan

  • pytest tests/unit/test_markdown_links.py tests/unit/test_reason_codes_documented.py tests/unit/test_parity_matrix.py tests/unit/test_cli_scan_json.py — 71 passed
  • python scripts/check_markdown_links.py --root . — 51 files, no broken links
  • python -m tools.parity.generate_parity --check — exit 0
  • CI green (docs-only change; the full matrix still runs)

Update (2026-08-25, second commit)

  • Repo URLs now point at DobermanCore/Doberman-Core (README badges and images, CONTRIBUTING, SECURITY, CHANGELOG, PARITY via its generator, pyproject [project.urls], issue template, codex plugin manifest). Old fu351/ URLs redirect.
  • ci.yml forwards GITLEAKS_LICENSE to gitleaks-action, which organization repos require. secret-scan stays red until the GITLEAKS_LICENSE repository secret exists; then re-run the failed job.
  • Merge plan (fu351, 2026-08-25): merge this PR first; when feat(cli): add --quiet to doberman demo (#441) #447 and fix(uninstall): exclude project from still-installed global hooks #414 land, re-apply their doc deltas by hand (--quiet row for doberman demo in docs/CLI.md; the global-hook exclusion section in README / docs/SETUP.md).

fu351 added 2 commits August 25, 2026 01:31
…nto TUNING, PLUGINS, RECOVERY, TURN_GATE

Every page under docs/, the README, CONTRIBUTING.md, and the OpenClaw adapter
README were rewritten against the live v0.18.1 --help output and the source,
in a plain, specific voice. README is now a front door (6.9k -> 3.5k words);
its deep sections moved to docs/TUNING.md, docs/PLUGINS.md, docs/RECOVERY.md
and docs/TURN_GATE.md. CLI reference covers all 37 commands; REASON_CODES.md
header fixed to 57 and five raise-site columns corrected; the two release docs
merged into docs/RELEASING.md; audit_otel.md states the real failed-post log
level. These files are the source of docs.trydoberman.dev.
… to gitleaks-action

The repository moved from fu351/Doberman-Core to DobermanCore/Doberman-Core.
Badges, images, links, pyproject project.urls, the issue template, the codex
plugin manifest and the parity generator now use the org path (old URLs still
redirect). gitleaks-action requires a license key for organization-owned repos,
so the secret-scan job now forwards the GITLEAKS_LICENSE repository secret.
@fu351
fu351 merged commit a85e568 into main Aug 25, 2026
11 of 12 checks passed
@fu351
fu351 deleted the docs/rewrite-for-docs-site branch August 25, 2026 16:42
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