Design modular Slugkit package architecture #229

Merged
erik merged 1 commit from feat/task-ca166842-package-architecture into main 2026-06-28 22:30:44 -05:00
Owner

Summary

  • Add docs/package-architecture.md with the proposed @evcraddock/slug-* package architecture.
  • Define package boundaries, dependency direction, incremental extraction phases, generated-site consumption model, versioning, publishing, and risks.
  • Add docs/npm-specs/ implementation specs for each package extraction unit, including template consumption and npm publish/deployment requirements.
  • Link the package architecture from the main architecture document.

Verification

  • ./scripts/pre-pr.sh
  • Forgejo CI build-lint-test passed for commit a368519.

Task: #task-ca166842

## Summary - Add `docs/package-architecture.md` with the proposed `@evcraddock/slug-*` package architecture. - Define package boundaries, dependency direction, incremental extraction phases, generated-site consumption model, versioning, publishing, and risks. - Add `docs/npm-specs/` implementation specs for each package extraction unit, including template consumption and npm publish/deployment requirements. - Link the package architecture from the main architecture document. ## Verification - `./scripts/pre-pr.sh` - Forgejo CI `build-lint-test` passed for commit `a368519`. Task: #task-ca166842
docs: design Slugkit package architecture
All checks were successful
CI / build-lint-test (pull_request) Successful in 48s
5d03860ec9
Task: #task-ca166842
Author
Owner

Review summary

Approved. The PR adds the requested package architecture design and links it from the main architecture document.

Acceptance criteria

  • Documented architecture/design proposal exists in the repository: docs/package-architecture.md.
  • Proposal uses the @evcraddock/slug-* package naming strategy.
  • Proposal includes dependency direction and package dependency graph.
  • Proposal defines an incremental one-package-at-a-time implementation plan.
  • Proposal describes generated-site package consumption, ownership, customization, and escape hatches.
  • Proposal identifies follow-up implementation tasks/phases.

Blocking issues

None.

Warnings

None.

Verdict

Approved.

## Review summary Approved. The PR adds the requested package architecture design and links it from the main architecture document. ## Acceptance criteria - [x] Documented architecture/design proposal exists in the repository: `docs/package-architecture.md`. - [x] Proposal uses the `@evcraddock/slug-*` package naming strategy. - [x] Proposal includes dependency direction and package dependency graph. - [x] Proposal defines an incremental one-package-at-a-time implementation plan. - [x] Proposal describes generated-site package consumption, ownership, customization, and escape hatches. - [x] Proposal identifies follow-up implementation tasks/phases. ## Blocking issues None. ## Warnings None. ## Verdict Approved.
erik force-pushed feat/task-ca166842-package-architecture from 5d03860ec9
All checks were successful
CI / build-lint-test (pull_request) Successful in 48s
to a3685196b7
All checks were successful
CI / build-lint-test (pull_request) Successful in 49s
2026-06-28 22:25:23 -05:00
Compare
Author
Owner

Review summary

Approved after the npm-specs expansion. The PR now includes the package architecture plus implementation-unit specs that require template-site consumption and npm publish/deployment outcomes for each package.

Acceptance criteria

  • Documented architecture/design proposal exists in the repository: docs/package-architecture.md.
  • Proposal uses the @evcraddock/slug-* package naming strategy.
  • Proposal includes dependency direction and package dependency graph.
  • Proposal defines an incremental one-package-at-a-time implementation plan.
  • Proposal describes generated-site package consumption, ownership, customization, and escape hatches.
  • Proposal identifies follow-up implementation tasks/phases through docs/npm-specs/.

Additional review notes

  • docs/npm-specs/ breaks the architecture into concrete implementation specs.
  • Each package spec includes template-site integration requirements.
  • Each package spec includes release/deployment requirements for npm publication and post-publish verification.

Blocking issues

None.

Warnings

None.

Verdict

Approved.

## Review summary Approved after the npm-specs expansion. The PR now includes the package architecture plus implementation-unit specs that require template-site consumption and npm publish/deployment outcomes for each package. ## Acceptance criteria - [x] Documented architecture/design proposal exists in the repository: `docs/package-architecture.md`. - [x] Proposal uses the `@evcraddock/slug-*` package naming strategy. - [x] Proposal includes dependency direction and package dependency graph. - [x] Proposal defines an incremental one-package-at-a-time implementation plan. - [x] Proposal describes generated-site package consumption, ownership, customization, and escape hatches. - [x] Proposal identifies follow-up implementation tasks/phases through `docs/npm-specs/`. ## Additional review notes - `docs/npm-specs/` breaks the architecture into concrete implementation specs. - Each package spec includes template-site integration requirements. - Each package spec includes release/deployment requirements for npm publication and post-publish verification. ## Blocking issues None. ## Warnings None. ## Verdict Approved.
erik merged commit bfa747e545 into main 2026-06-28 22:30:44 -05:00
erik deleted branch feat/task-ca166842-package-architecture 2026-06-28 22:30:44 -05:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
erik/slugkit!229
No description provided.