Skip to content

docs: reconcile every markdown file with the current repository state #3399

Description

@Xore

Problem

146 first-party markdown files. Nothing machine-checks them, so drift is silent.

The mechanical half is now fixed in #3398 (mermaid parse gate, whole-tree link
gate, the two broken diagrams, the one dead link, both wired into quality.yml).
This issue tracks what a script cannot do: the semantic drift — docs
asserting stack counts, port numbers, index names, route tables and env-var
defaults that the compose files, arcane/manifests/home-production.json and the
source have moved past. The oldest narrative docs have not been touched since
2026-07-26.

Method, per file

For each task below, compare the doc's claims against reality and correct the
doc — do not correct reality to match the doc, except where the doc is the
authoritative design record. A plan/record doc may legitimately describe intent
that is not shipped; mark it as such rather than rewriting its history.

Cheapest sources of truth, in order:

  1. arcane/manifests/home-production.json — the stack inventory
  2. arcane/home/*/compose.yml — services, ports, env, profiles
  3. git ls-files arcane/home | cut -d/ -f3 | sort -u — the actual stack count
  4. arcane/home/honeypot-dashboard/backend-service/src/main.rs — the route table
  5. arcane/home/honeypot-init/ — ES templates, pipelines, ILM
  6. grep -rn 'profiles:' --include='*.yml'
  7. graphify query "..." / graphify explain "..." when a claim spans files

Rules:

  • A task is closed when the file was corrected or explicitly re-verified as
    accurate
    . Record which, in the PR body. No silent skips.
  • Do not restyle prose that is not wrong. Minimal diffs.
  • Numbers, counts and identifiers must be checked, not eyeballed.
  • If a doc is genuinely obsolete, say so and propose deletion rather than
    patching it to look current.

Task list, oldest doc first

Group A — the six oldest

Group B — analysis / ghidra

Group C — sandbox

Group D — core architecture / operations

Deliberately out of scope

  • Vendored / decoy-fs copies — arcane/home/honeypot-cowrie/cowrie/honeyfs/**,
    sandbox/ghosts/vendor/**. Someone else's README, inside a fake filesystem an
    attacker is meant to explore.
  • Frozen records — docs/sandbox/windows/vm-detection-results/* (14 files),
    docs/benchmarks/runs/*, docs/research/*, *-record.md,
    approval-record.md, docs/sandbox/windows_kimi/*, dev/sensing-lab/. A
    record's value is that it says what was true on the day; reconciling it
    destroys it.
  • One-off working notes at the repo root — DIFF.md, EVIDENCE.md,
    HANDOFF-3097.md. These look like they should just be deleted, but that is a
    separate call, not a docs fix.

Acceptance

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions