Skip to content

Comments

Cleanup/open scaffold architecture#159

Open
AaronAbuUsama wants to merge 15 commits intodevfrom
cleanup/open-scaffold-architecture
Open

Cleanup/open scaffold architecture#159
AaronAbuUsama wants to merge 15 commits intodevfrom
cleanup/open-scaffold-architecture

Conversation

@AaronAbuUsama
Copy link
Contributor

No description provided.

AaronAbuUsama and others added 15 commits January 29, 2026 00:01
- Deleted outdated documentation files: HANDOFF.md, progress.txt, and several guides related to the SDK and architecture.
- Updated package.json to remove the stray clean script and adjusted vitest configuration paths for consistency across packages.
- Introduced new documentation files covering API reference, architecture, and workflow building to enhance developer experience.
- Cleaned up scripts to streamline the build process and ensure no stray artifacts remain in source directories.

This commit reflects a significant cleanup and reorganization of the codebase, focusing on improving clarity and usability for developers.
- Added AnthropicProvider import to README and updated usage examples across various documentation files.
- Enhanced API reference with new InteractionRequestPayload and InteractionResponsePayload interfaces for improved human-in-the-loop interactions.
- Updated architecture and building workflows documentation to reflect changes in provider usage and database paths.
- Corrected the number of React hooks in the React Integration documentation.

These changes improve clarity and provide developers with updated guidance on using the new provider structure.
- Introduced ADR-001 documenting the design and consolidation of the execution API, merging six functions into a single `run()` API for improved clarity and usability.
- Created a technical debt inventory to track issues and resolutions related to the API changes.
- Updated the ADR README to outline the structure and purpose of the documentation.

These additions enhance the project's documentation and provide a clear framework for future architectural decisions.
- Accept ADR-005: Effect Schema at system boundaries only
- Update TYPE issues: mark boundary issues resolved by ADR-005,
  mark internal issues resolved by ADR-004/006/008
- Correct Related Issues in ADR-001, 003, 008, 010 for accuracy
- Update inventory: 56 resolved, 40 remaining
- All 10 ADRs now Accepted and cross-consistent
- Add HTTP Server Implementation section to ADR-009
- Decision: migrate from raw Node.js to @effect/platform-node
- Update inventory: ARCH-013 resolved by ADR-009, TYPE-003 clarified
- ADR-011: Service Instantiation Pattern (ARCH-002)
- ADR-012: Phase Lifecycle Specification (ARCH-017)
- Both Proposed, awaiting decisions on:
  - Layer composition patterns (factories vs presets)
  - Phase error handling (fail-fast vs retry vs rollback)
- Update README with new ADRs
Add comprehensive React hooks architecture using React Query with
three-tier structure (primitives, grouped, unified). Server-side
state derivation per ADR-006. SSE updates React Query cache.

Resolves: ARCH-008, API-010, DEAD-010, TEST-012, TEST-013, DOC-003
Updates inventory: 63 resolved, 33 remaining

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fixed summary counts: 63/33 → 65/31
- Added TYPE-014 to ADR-002 Issues Resolved
- Added TYPE-015 to ADR-006 Issues Resolved
- Added TYPE-001 to ADR-008 Issues Resolved
- Added ARCH-013 to ADR-009 Issues Resolved

All 65 resolved issues now accurately tracked in ADR Index.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Changed status of ADR-012 from Proposed to Accepted.
- Defined phase lifecycle with entry guards, setup/teardown hooks, and error recovery strategies.
- Updated decision area to include a detailed state machine diagram and clarified guard conditions.
- Revised technical debt inventory to reflect resolution of ARCH-017 related to phase lifecycle specifications.

This update solidifies the framework for phase execution and error handling in workflows.
- Add .ralphy/config.yaml with project rules and boundaries
- Add PRD.md with decomposed tasks from ADRs 001-013
- Organize implementation into 7 phases with dependency ordering
- Include acceptance criteria and canonical ADR links
Add project-specific Ralphy workflow for ADR-driven technical debt resolution:

.claude/skills/ralphy-harness/
- SKILL.md: Project-specific Ralphy skill with ADR awareness
- references/task-generation-rules.md: Task decomposition guidelines
- references/adr-aware-workflow.md: ADR-driven workflow documentation
- scripts/validate-tasks.sh: Constitution validation script

.ralphy/
- PRD.md: Links to 13 ADRs, lists 31 remaining issues
- constitution.md: MUST/SHOULD rules derived from CLAUDE.md

Configured for single-agent, no-worktree execution per config.yaml.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Generated from PRD and ADRs with constitution validation:
- Phase 1: Event System (ADR-004) - 6 tasks
- Phase 2: State Sourcing (ADR-006) - 5 tasks
- Phase 3: Type Safety (ADR-005) - 5 tasks
- Phase 4: API Consolidation (ADR-001, 003) - 5 tasks
- Phase 5: Provider/HITL (ADR-002, 010) - 9 tasks
- Phase 6: React Hooks (ADR-013) - 8 tasks
- Phase 7: Test Coverage (TEST-*) - 7 tasks
- Phase 8: Cleanup (DEAD-*, DOC-*) - 8 tasks

Each task has acceptance criteria and verification commands.
Constitution validation: PASSED (no MUST or SHOULD violations)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Finalize ADR-011 (Service Instantiation) as Accepted
- Finalize ADR-012 (Phase Lifecycle) with discriminated unions
- Clean up technical debt inventory (69 resolved, 21 remaining)
- Remove ARCH-022 and DOC items per decision
- Add .ralphy/config.yaml with project rules
- Add PRD.md with implementation tasks for all ADRs
- Add Ralphie tasks.yaml for execution tracking
- Add validation summary and reports
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