docs: rewrite README and docs/ for accuracy and voice; split README into guides - #458
Merged
Conversation
…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.
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
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-tonedocs/PLUGINS.md(new): custom guardrail + webhook audit sink via entry pointsdocs/RECOVERY.md(new):taint clear,tools approve,memory reset/prune,uninstall/uninstall-hooksdocs/TURN_GATE.md(new): the README turn-gate section plus the module map and invariants2fagroup,uninstall,message-tone,tools approvewere undocumented); exit-code collision audit corrected to the real count (45); JSON-contract sections re-verified againstcli/main.pyandcli/doctor.py.secret_exfiltration,multi_step_exfil,confirmed_exfil→hosthooks/hookio.py;correlated_trifecta,correlated_destructive_flow→engine/correlator.py); redundant Value column dropped; plan-chip group names replaced with subsystem names.Claude Code hooks,MCP proxy,OpenClaw) kept verbatim.RELEASING.mdis a pointer); the sdist file list now matchespyproject.toml(tools/was missing).CHANGELOG.md/SECURITY.mdlinks updated to the new anchor location.warning, notdebug(checked againstotel_sink.py).tools/parity/generate_parity.pyheader strings updated so--checkstays byte-identical.Ground truth for every command and flag was a full
--helpdump of every command fromsrc/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 passedpython scripts/check_markdown_links.py --root .— 51 files, no broken linkspython -m tools.parity.generate_parity --check— exit 0Update (2026-08-25, second commit)
DobermanCore/Doberman-Core(README badges and images, CONTRIBUTING, SECURITY, CHANGELOG, PARITY via its generator,pyproject[project.urls], issue template, codex plugin manifest). Oldfu351/URLs redirect.ci.ymlforwardsGITLEAKS_LICENSEto gitleaks-action, which organization repos require.secret-scanstays red until theGITLEAKS_LICENSErepository secret exists; then re-run the failed job.--quietrow fordoberman demoindocs/CLI.md; the global-hook exclusion section in README /docs/SETUP.md).