refactor: adopt the .abcd/development namespace for developer docs (v0.7.1)#5
Merged
Merged
Conversation
…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.
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.
v0.7.1 — adopt the
.abcd/developmentnamespace for developer docsAligns ferry with the sibling
abcd-clirepo so thatdocs/is user-facing only(the four Diátaxis directories). Developer-facing records move out of
docs/into anew
.abcd/development/namespace, and ferry's repo scaffolding now stamps that layout.Moves
docs/plans/,docs/decisions/→.abcd/development/{plans,decisions}(tracked renames).abcd/development/research/(incl. the CLI-surface and docs-structure studies)docs/now holds onlytutorials/ how-to/ reference/ explanation/(+ assets, README)Scaffold generator (the cross-repo bit)
internal/agents/scaffold.gonow creates.abcd/development/{plans,research,decisions}instead of
docs/*for those dev dirs — so every repo ferry scaffolds gets the newlayout. 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/buildclean;go test ./...(incl. scaffold goldens) + full evals green;consistency-lint,check-plan-shipped v0.7.1(plan marked shipped), anddocs-currency-lintall pass;
git grepshows no livedocs/{plans,research,decisions}references.Scope / follow-ups
.work/,.work.local/) stays at the repo root — folding it under.abcd/is a small phase-2.ABCDevelopment/CLAUDE.mdconvention is updated to match (org-wide).~/.config/ferry/repo/agents/templates/docs-README.md,ferry-managed, outside this repo) still describes the old
docs/dev-dirs — needs its maprepointed +
ferry apply. Flagged for a separate config-repo change.After merge:
scripts/release.sh v0.7.1cuts the tagged release. Then v0.7.2 (theEmacs/iTerm2/tmux hardening) is authored directly in
.abcd/development/plans/.Assisted-by: Claude:claude-opus-4-8