docs(#265): AgDR-0029 framework packaging & distribution (proposed)#267
docs(#265): AgDR-0029 framework packaging & distribution (proposed)#267atlas-apex wants to merge 1 commit into
Conversation
- Lists 7 packaging options: status-quo fork, release-tarball, layered install, npm, Homebrew, install script, git submodule - Pros / cons / migration cost per option - Combination plays (2+3 staged, 3+4 layered, 3 + brand mitigation) - Recommends option 3 (layered install) with brand-mitigation pattern - Decision section left empty pending operator pick via PR comment Refs #265 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
atlas-apex
left a comment
There was a problem hiding this comment.
Code Review: PR #267
Commit: 2f59e7181a3c5d7a9991b18bcc607959c88037dd
Summary
Docs-only PR adding docs/agdr/AgDR-0029-framework-packaging-and-distribution.md at status proposed. Frames seven packaging-and-distribution options for the framework with a clear lean (option 3 + brand mitigation) and an intentionally empty Decision section pending operator pick.
Checklist Results
- Architecture & Design: N/A (docs)
- Code Quality: N/A (docs)
- Testing: N/A (docs)
- Security: Pass — no secrets, no private-project refs
- Performance: N/A
- PR Description & Glossary: Pass — Glossary present with 5 well-scoped terms
- Technical Decisions (AgDR):Pass — the PR IS the AgDR
- Adopter Handbooks: N/A (no code paths matched)
Issues Found
None.
Notes
- Frontmatter shape is consistent with the extended AgDR schema used by recent records (AgDR-0021, AgDR-0023). It extends
templates/agdr.md's minimal shape withid / timestamp / agent / model / session / trigger / status / category— matches established practice. - Linked records all resolve: AgDR-0007, AgDR-0021, AgDR-0023 exist at the referenced paths.
- "Status: PROPOSED" + empty Decision section is intentional and clearly flagged in the body, the TL;DR quote block, and the Decision section itself. The reader cannot mistake this for a finalised decision.
- Options table is well-shaped: pros / cons / migration cost per option, plus three combination plays called out separately. The recommendation explicitly names the option being rejected (status quo) and why.
- Glossary terms are domain-specific and earn their place.
- No leaks: no managed-project names referenced.
Suggestions
- Once the operator picks, the Decision + Consequences sections will need a follow-up commit. Consider also flipping
status: proposed→status: acceptedin the frontmatter at that point and adding the PR URL to Artifacts (currently(will be filled in once opened)).
Verdict
APPROVED (posted as COMMENT — Rex is the PR author and cannot self-approve via GraphQL). Awaiting operator pick to finalise the Decision section in a follow-up commit.
Reviewed by Rex (Code Reviewer Agent)
Reviewed commit: 2f59e7181a3c5d7a9991b18bcc607959c88037dd
|
Parking this PR for now — converting to draft. The AgDR-0029 packaging decision can wait until after the v1.3.0 release cut; revisit when capacity allows. The diff and Decision section will stay intact (status: PROPOSED) and the AgDR is referenceable on |
Summary
Authors AgDR-0029 —
docs/agdr/AgDR-0029-framework-packaging-and-distribution.md— proposing a packaging & distribution model for the ApexYard framework. Status: PROPOSED. Decision section is empty pending operator (Ahmed) comment with their pick.Options compared
.apexyard/read-only dir + overlay) — current leannpx apexyard init)curl | bash)Plus combination plays: 2 + 3 staged, 3 + 4 layered, 3 + brand mitigation.
Recommendation
Option 3 (layered install) with brand-mitigation pattern — visible install dir name (
apexyard/not.apexyard/), registry stays at fork root, fork-rootREADME.mdnames the framework. Rationale + tradeoffs in the AgDR's Recommendation section.How to comment
Pick by commenting on this PR with the option number (e.g. "go with 3 + brand mitigation" or "prefer 2 → 3 staged"). Once decided I'll fill in the Decision and Consequences sections in a follow-up commit and re-request review.
Closes #265 once the operator pick is recorded.
Testing
Glossary
apexyard/) + adopter-customisation overlay outside itapexyard uninstalldevfor daily work,mainfor tagged releases only