Skip to content

docs: wipe all documentation for clean reference-docs rewrite#168

Merged
aksOps merged 1 commit into
mainfrom
docs/wipe-all
May 14, 2026
Merged

docs: wipe all documentation for clean reference-docs rewrite#168
aksOps merged 1 commit into
mainfrom
docs/wipe-all

Conversation

@aksOps
Copy link
Copy Markdown
Contributor

@aksOps aksOps commented May 14, 2026

Summary

User-requested doc nuke ahead of rewriting the reference documentation from scratch.

The existing docs were a mix of Java-era specs (obsolete after Phase 6 cutover), point-in-time plans (Go-port phases 1–6, OOM-fix), and partial v0.4.0-state references that didn't form a coherent reference. Wiping for a single clean rewrite is faster than re-anchoring each file.

Deleted (24 files / ~5.9k lines)

Top-level (6):

  • `AGENTS.md`
  • `CHANGELOG.md`
  • `CLAUDE.md`
  • `PROJECT_SUMMARY.md`
  • `README.md`
  • `SECURITY.md`

`docs/` (10):

  • `docs/audits/` × 2 (Java-era serve-path prod-readiness audits)
  • `docs/codeiq.yml.example` (config sample)
  • `docs/plans/` × 2 (Java-era resolver SPI + AKS deploy)
  • `docs/specs/` × 2 (Java-era specs)
  • `docs/superpowers/baselines/` × 2 (Phase B exit gate baseline)
  • `docs/superpowers/plans/2026-05-13-enrich-oom-fix.md`

`shared/runbooks/` (8):

  • `aks-oom-quick-fix.md`, `aks-read-only-deploy.md` (Java-era)
  • `release.md` (Java-era — Go path lives in `release-go.md`)
  • `release-go.md`, `engineering-standards.md`, `first-time-setup.md`, `rollback.md`, `test-strategy.md`

Preserved

  • `LICENSE` — legal artifact
  • `testdata/fixture-minimal/README.md` — test fixture content (used by detectors)
  • `.github/workflows/*` — CI configs, not docs
  • All source code — code comments stay with their code

CI graceful degradation (no fixes needed)

  • `.goreleaser.yml` has `files: - README.md` in the archive bundle — silent-skips absent files
  • `.github/workflows/release-darwin.yml` copies LICENSE/README/CHANGELOG with `|| true` — degrades gracefully

The release pipeline keeps working; release archives just won't include README/CHANGELOG until the new docs land.

Test plan

  • Build still clean — only docs touched, no source code changes.
  • Test fixture `testdata/fixture-minimal/README.md` preserved (verified via `git ls-files`).
  • After merge: GitHub repo home page will show no README until new docs ship.

🤖 Generated with Claude Code

User-requested full doc nuke. The existing docs were a mix of
Java-era specs (now obsolete after Phase 6 cutover), point-in-time
plans (Go-port phases 1-6, OOM-fix), and partial v0.4.0-state
references that didn't form a coherent reference. Wiping them for
a single clean rewrite is faster than re-anchoring each file.

Deleted (24 files / ~5.9k lines):

  AGENTS.md, CHANGELOG.md, CLAUDE.md, PROJECT_SUMMARY.md,
  README.md, SECURITY.md

  docs/audits/2026-04-28-serve-path-prod-readiness*.md (2)
  docs/codeiq.yml.example
  docs/plans/2026-04-2[78]-sub-project-*.md (2)
  docs/specs/2026-04-2[78]-*-design.md (2)
  docs/superpowers/baselines/2026-04-17/{BASELINE,PHASE-B-EXIT-GATE}.md
  docs/superpowers/plans/2026-05-13-enrich-oom-fix.md

  shared/runbooks/{aks-oom-quick-fix,aks-read-only-deploy,
    engineering-standards,first-time-setup,release-go,release,
    rollback,test-strategy}.md

Preserved:

  LICENSE                                  — legal artifact
  testdata/fixture-minimal/README.md       — test fixture content
                                              (exercises detectors)
  .github/workflows/*                      — CI configs, not docs
  source code                              — comments stay with code
  .goreleaser.yml                          — references README.md
                                              via `files:` pattern;
                                              will silent-skip until
                                              README returns
  .github/workflows/release-darwin.yml     — copies LICENSE/README/
                                              CHANGELOG with
                                              `|| true`; degrades
                                              gracefully

The release pipeline keeps working; release archives just won't
include README/CHANGELOG until the new docs land.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@aksOps aksOps merged commit 61230ae into main May 14, 2026
13 checks passed
@aksOps aksOps deleted the docs/wipe-all branch May 14, 2026 16:44
aksOps added a commit that referenced this pull request May 14, 2026
…ing (#169)

The .goreleaser.yml `files:` entries were bare filenames (`README.md`,
`CHANGELOG.md`) which goreleaser treats as required: globbing fails
hard when the file doesn't exist:

  globbing failed for pattern README.md: matching "./README.md":
  file does not exist

This bit v0.4.2 — every release would fail after #168 wiped the docs
until the new reference docs land.

Switch each bare filename to a glob (`README.md*`, `CHANGELOG.md*`).
Goreleaser silently skips patterns that match zero files. The trailing
`*` matches the file when present and nothing when absent — gracefully
covering both "docs landed" and "docs not yet rewritten" states.

`LICENSE*` already used this pattern. No behavior change when a
README is present.

`release-darwin.yml` already wraps its `cp` commands in `|| true`,
so it was unaffected — only goreleaser-side bundling broke.

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
aksOps added a commit that referenced this pull request May 14, 2026
User-requested full reference-doc set ahead of stopping codeiq work
with Claude Code. Replaces the doc-wipe slate from PR #168 with a
coherent, source-grounded reference tree.

Created (15 files / ~2,200 lines / ~180 KB):

  README.md                                 — user-facing entry + badges
  CLAUDE.md                                 — agent-facing repo guide
  docs/00-project-overview.md              — what / who / status
  docs/01-local-setup.md                   — build / test / common issues
  docs/02-architecture.md                  — components + tradeoffs
  docs/03-code-map.md                      — directory-by-directory tour
  docs/04-main-flows.md                    — index / enrich / mcp / review
  docs/05-configuration.md                 — env / flags / config files
  docs/06-data-model.md                    — Kuzu + SQLite schemas + taxonomy
  docs/07-integrations.md                  — Ollama + Sigstore + zero else
  docs/08-testing.md                       — strategy + fixtures + perf-gate
  docs/09-build-deploy-release.md          — Goreleaser + cosign keyless
  docs/10-known-risks-and-todos.md         — gotchas / debt / sec-sensitive
  docs/11-agent-handoff.md                 — one-stop brief for next agent
  docs/adr/0001-current-architecture.md   — why the shape is what it is

Grounding policy:

  * Every concrete claim points at a file. Uses `path/to/file:line`
    form where line-level matters.
  * Anything not directly verified is marked `Inference`.
  * Anything unknown is marked `Unknown`.
  * No code changes. Only docs.

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
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