Docs: product README + portable runbook #1

Open
opened 2026-08-13 14:05:46 +01:00 by eSlider · 2 comments
Owner

Why

Public face still reads as a laptop tool (search.ops.io, bin/kb/*, Cursor as runtime).

Do

  • Rewrite docs/README.md + root README.md as a portable product (Diataxis).
  • Record PLAN decisions D3 (SearXNG compose), D6 (Go service / Python sidecar), D14 strict (bin/{subject}/{method}.go), D15 (Gitea origin), D17 (assertion gate), D18 (pluggable reasoner).
  • Point GitHub issues at this Gitea board. No host-absolute paths, no kb in new prose.

Test

  • Docs match live commands after issue 13 rename, or clearly mark old paths as deprecated.
## Why Public face still reads as a laptop tool (`search.ops.io`, `bin/kb/*`, Cursor as runtime). ## Do - Rewrite `docs/README.md` + root `README.md` as a portable product (Diataxis). - Record PLAN decisions D3 (SearXNG compose), D6 (Go service / Python sidecar), D14 strict (`bin/{subject}/{method}.go`), D15 (Gitea origin), D17 (assertion gate), D18 (pluggable reasoner). - Point GitHub issues at this Gitea board. No host-absolute paths, no `kb` in new prose. ## Test - Docs match live commands after issue 13 rename, or clearly mark old paths as deprecated.
Author
Owner

Partial: README/PLAN/AGENTS now point at this board. Merged GitHub PR https://github.com/eSlider/2dph/pull/7 (D15). Remaining on this issue: portable product README rewrite (Diataxis), drop laptop lore (search.ops.io, bin/kb/* as the product API).

Partial: README/PLAN/AGENTS now point at this board. Merged GitHub PR https://github.com/eSlider/2dph/pull/7 (D15). Remaining on this issue: portable product README rewrite (Diataxis), drop laptop lore (`search.ops.io`, `bin/kb/*` as the product API).
Author
Owner

PR (GitHub): https://github.com/eSlider/2dph/pull/10

Partial: README/PLAN/design/skills now name bin/brain/search.go. --hop documented as error, not a walk. Unittest bin/tools/test_published_docs.py gates it.

Still open after this PR: portable product README rewrite, PicoClaw runbook, SearXNG skill URL (search.ops.io still stale).

PR (GitHub): https://github.com/eSlider/2dph/pull/10 Partial: README/PLAN/design/skills now name `bin/brain/search.go`. `--hop` documented as error, not a walk. Unittest `bin/tools/test_published_docs.py` gates it. Still open after this PR: portable product README rewrite, PicoClaw runbook, SearXNG skill URL (`search.ops.io` still stale).
Sign in to join this conversation.
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: eSlider/2dph#1