Skip to content

refactor: adopt the .abcd/development namespace for developer docs (v0.7.1)#5

Merged
REPPL merged 1 commit into
mainfrom
feat/v0.7.1-abcd-docs-structure
Jul 8, 2026
Merged

refactor: adopt the .abcd/development namespace for developer docs (v0.7.1)#5
REPPL merged 1 commit into
mainfrom
feat/v0.7.1-abcd-docs-structure

Conversation

@REPPL

@REPPL REPPL commented Jul 8, 2026

Copy link
Copy Markdown
Owner

v0.7.1 — adopt the .abcd/development namespace for developer docs

Aligns ferry with the sibling abcd-cli repo so that docs/ is user-facing only
(the four Diátaxis directories). Developer-facing records move out of docs/ into a
new .abcd/development/ namespace, and ferry's repo scaffolding now stamps that layout.

Moves

  • docs/plans/, docs/decisions/.abcd/development/{plans,decisions} (tracked renames)
  • research → .abcd/development/research/ (incl. the CLI-surface and docs-structure studies)
  • docs/ now holds only tutorials/ how-to/ reference/ explanation/ (+ assets, README)

Scaffold generator (the cross-repo bit)

internal/agents/scaffold.go now creates .abcd/development/{plans,research,decisions}
instead of docs/* for those dev dirs — so every repo ferry scaffolds gets the new
layout. Golden tests updated. This is why it's a user-facing "Changed", not a silent refactor.

Tooling + docs repointed

check-plan-shipped.sh, release.yml, consistency-lint.sh, docs/README.md,
CONTRIBUTING.md, both release/scaffold how-tos, AGENTS.md. Added .abcd/ structure READMEs.

Verification

gofmt/vet/build clean; go test ./... (incl. scaffold goldens) + full evals green;
consistency-lint, check-plan-shipped v0.7.1 (plan marked shipped), and docs-currency-lint
all pass; git grep shows no live docs/{plans,research,decisions} references.

Scope / follow-ups

  • Working memory (.work/, .work.local/) stays at the repo root — folding it under
    .abcd/ is a small phase-2.
  • The cross-repo ABCDevelopment/CLAUDE.md convention is updated to match (org-wide).
  • Config-repo scaffold template (~/.config/ferry/repo/agents/templates/docs-README.md,
    ferry-managed, outside this repo) still describes the old docs/ dev-dirs — needs its map
    repointed + ferry apply. Flagged for a separate config-repo change.

After merge: scripts/release.sh v0.7.1 cuts the tagged release. Then v0.7.2 (the
Emacs/iTerm2/tmux hardening) is authored directly in .abcd/development/plans/.

Assisted-by: Claude:claude-opus-4-8

…0.7.1)

Align ferry with the sibling abcd-cli repository so that docs/ is user-facing
only. Developer-facing records move out of the user-facing docs/ tree into a new
.abcd/development/ namespace, and ferry's repo scaffolding now stamps that layout.

- Move docs/plans, docs/research, docs/decisions -> .abcd/development/{plans,
  research,decisions}; docs/ now holds only the four Diátaxis directories.
- Scaffold generator: internal/agents/scaffold.go now creates
  .abcd/development/{plans,research,decisions} instead of docs/* for those dev
  dirs (docs/ still seeds its README); golden tests updated accordingly.
- Release + lint tooling repointed: check-plan-shipped.sh, release.yml,
  consistency-lint.sh.
- Docs/agent text repointed: docs/README.md, CONTRIBUTING.md, the two release/
  scaffold how-tos, AGENTS.md.
- Add .abcd/ structure READMEs; record the CLI-surface and docs-structure
  research under .abcd/development/research/.

Working memory (.work/, .work.local/) stays at the repo root; folding it under
.abcd/ is a follow-up phase. The cross-repo convention (ABCDevelopment/CLAUDE.md)
is updated to match.

CHANGELOG: [0.7.1] Changed.
@REPPL REPPL merged commit d2118ca into main Jul 8, 2026
12 checks passed
@REPPL REPPL deleted the feat/v0.7.1-abcd-docs-structure branch July 8, 2026 11:26
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