docs(readme): sync v1 core handoff
This commit is contained in:
parent
05d710bdd8
commit
db1e115e9c
5 changed files with 67 additions and 20 deletions
|
|
@ -1,7 +1,8 @@
|
||||||
# Current Software Plan
|
# Current Software Plan
|
||||||
|
|
||||||
Execute active V1 block documents in numeric order. Blocks 01-09 are completed
|
Execute active V1 block documents in numeric order. Blocks 01-09 are completed
|
||||||
and archived; the next active block is Block 10.
|
and archived; Block 10 is active. Chunks 10.1-10.3 are complete, and Chunk 10.4
|
||||||
|
is next after the `low` mode breakpoint confirmation.
|
||||||
|
|
||||||
## Execution rules
|
## Execution rules
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# V1 Block 10 — Testing, Documentation, and Handoff
|
# V1 Block 10 — Testing, Documentation, and Handoff
|
||||||
|
|
||||||
Status: In progress — Chunk 10.2 complete
|
Status: In progress — Chunk 10.3 complete
|
||||||
|
|
||||||
Purpose: Ensure the V1 scheduling core is understandable, tested, and ready for future UI work.
|
Purpose: Ensure the V1 scheduling core is understandable, tested, and ready for future UI work.
|
||||||
|
|
||||||
|
|
@ -108,6 +108,13 @@ Acceptance criteria:
|
||||||
- Plan files accurately distinguish complete, active, and future work.
|
- Plan files accurately distinguish complete, active, and future work.
|
||||||
- Breakpoints and recommended Codex levels remain accurate after any renumbering.
|
- Breakpoints and recommended Codex levels remain accurate after any renumbering.
|
||||||
|
|
||||||
|
Completion notes:
|
||||||
|
|
||||||
|
- Updated the root `README.md` to describe the current implemented V1 core, current module/test layout, standard verification commands, and MongoDB persistence boundary.
|
||||||
|
- Updated `DOCUMENTATION_PASS_SUMMARY.md` so it reflects the current documented files and successful V1 verification environment.
|
||||||
|
- Confirmed `Human Documentation/Starter Architecture Notes.md` already reflects the MongoDB-only future persistence direction and the current no-runtime-database boundary.
|
||||||
|
- Confirmed no docs claim V2-only features are implemented in V1, and no SQLite/Drift assumptions are present.
|
||||||
|
|
||||||
BREAKPOINT: Stop here. Confirm `low` mode before archiving completed plans.
|
BREAKPOINT: Stop here. Confirm `low` mode before archiving completed plans.
|
||||||
|
|
||||||
## Chunk 10.4 — Archive completed plans
|
## Chunk 10.4 — Archive completed plans
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# V1 Block 10 — Testing, Documentation, and Handoff
|
# V1 Block 10 — Testing, Documentation, and Handoff
|
||||||
|
|
||||||
Status: In progress — Chunk 10.2 complete
|
Status: In progress — Chunk 10.3 complete
|
||||||
|
|
||||||
Purpose: Ensure the V1 scheduling core is understandable, tested, and ready for future UI work.
|
Purpose: Ensure the V1 scheduling core is understandable, tested, and ready for future UI work.
|
||||||
|
|
||||||
|
|
@ -108,6 +108,13 @@ Acceptance criteria:
|
||||||
- Plan files accurately distinguish complete, active, and future work.
|
- Plan files accurately distinguish complete, active, and future work.
|
||||||
- Breakpoints and recommended Codex levels remain accurate after any renumbering.
|
- Breakpoints and recommended Codex levels remain accurate after any renumbering.
|
||||||
|
|
||||||
|
Completion notes:
|
||||||
|
|
||||||
|
- Updated the root `README.md` to describe the current implemented V1 core, current module/test layout, standard verification commands, and MongoDB persistence boundary.
|
||||||
|
- Updated `DOCUMENTATION_PASS_SUMMARY.md` so it reflects the current documented files and successful V1 verification environment.
|
||||||
|
- Confirmed `Human Documentation/Starter Architecture Notes.md` already reflects the MongoDB-only future persistence direction and the current no-runtime-database boundary.
|
||||||
|
- Confirmed no docs claim V2-only features are implemented in V1, and no SQLite/Drift assumptions are present.
|
||||||
|
|
||||||
BREAKPOINT: Stop here. Confirm `low` mode before archiving completed plans.
|
BREAKPOINT: Stop here. Confirm `low` mode before archiving completed plans.
|
||||||
|
|
||||||
## Chunk 10.4 — Archive completed plans
|
## Chunk 10.4 — Archive completed plans
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
# Documentation Pass Summary
|
# Documentation Pass Summary
|
||||||
|
|
||||||
This archive is the same starter Dart scheduling core with expanded inline documentation added to the code files under `lib/`.
|
This repository is the pure Dart scheduling core with expanded inline
|
||||||
|
documentation in the code files under `lib/`.
|
||||||
|
|
||||||
## What changed
|
## What changed
|
||||||
|
|
||||||
|
|
@ -16,12 +17,13 @@ This archive is the same starter Dart scheduling core with expanded inline docum
|
||||||
- `lib/src/backlog.dart`
|
- `lib/src/backlog.dart`
|
||||||
- `lib/src/locked_time.dart`
|
- `lib/src/locked_time.dart`
|
||||||
- `lib/src/quick_capture.dart`
|
- `lib/src/quick_capture.dart`
|
||||||
|
- `lib/src/repositories.dart`
|
||||||
- `lib/src/scheduling_engine.dart`
|
- `lib/src/scheduling_engine.dart`
|
||||||
- `lib/src/task_actions.dart`
|
- `lib/src/task_actions.dart`
|
||||||
- `lib/src/task_statistics.dart`
|
- `lib/src/task_statistics.dart`
|
||||||
|
- `lib/src/timeline_state.dart`
|
||||||
|
|
||||||
## Behavior check
|
## Behavior check
|
||||||
|
|
||||||
Only comments and documentation text were added to the Dart files. A comparison that strips comments and blank lines reports the non-comment code as unchanged from the uploaded archive.
|
The current V1 verification pass completed with `dart pub get`,
|
||||||
|
`dart format lib test`, `dart analyze`, `dart test`, and `git diff --check`.
|
||||||
`dart format` was not run because the Dart SDK is not installed in this execution environment. The comments were inserted to preserve the existing formatting style as closely as possible.
|
|
||||||
|
|
|
||||||
56
README.md
56
README.md
|
|
@ -1,12 +1,21 @@
|
||||||
# ADHD Scheduling App Starter Project
|
# ADHD Scheduling App Core
|
||||||
|
|
||||||
This is a starter Dart project for an ADHD-focused scheduling application.
|
This is a pure Dart scheduling-core project for an ADHD-focused scheduling
|
||||||
|
application.
|
||||||
|
|
||||||
The repository intentionally starts with a **pure Dart scheduling core** before adding a full Flutter UI. The hardest part of the product is the scheduling behavior: flexible task shifting, locked time, backlog recovery, recurring availability blocks, and task-state correctness. Keeping that logic independent makes it easier to test and safer to hand off to Codex.
|
The repository intentionally keeps the scheduling core **pure Dart** before
|
||||||
|
adding a full Flutter UI. The hardest part of the product is the scheduling
|
||||||
|
behavior: flexible task shifting, locked time, backlog recovery, recurring
|
||||||
|
availability blocks, and task-state correctness. Keeping that logic independent
|
||||||
|
makes it easier to test and safer to hand off to Codex.
|
||||||
|
|
||||||
## Intended product direction
|
## Current V1 core status
|
||||||
|
|
||||||
- V1/MVP: Today view, backlog/wishlist, quick capture, flexible task pushing, recurring hidden locked blocks, task-state transitions, and a testable scheduling core.
|
- Implemented V1 core: Today timeline view models, backlog/wishlist behavior,
|
||||||
|
quick capture, flexible task insertion/pushing, recurring hidden locked blocks,
|
||||||
|
one-day locked-block overrides, required task state transitions, surprise task
|
||||||
|
logging, child task ownership/completion, internal statistics, and
|
||||||
|
persistence-preparation helpers.
|
||||||
- V2.0: Week/month views, reports, overwhelm shield, drag-and-drop, task history panels.
|
- V2.0: Week/month views, reports, overwhelm shield, drag-and-drop, task history panels.
|
||||||
- Persistence direction: MongoDB is the committed database target. Current V1
|
- Persistence direction: MongoDB is the committed database target. Current V1
|
||||||
work prepares repository interfaces and document-shaped mappings only; it does
|
work prepares repository interfaces and document-shaped mappings only; it does
|
||||||
|
|
@ -26,14 +35,33 @@ The repository intentionally starts with a **pure Dart scheduling core** before
|
||||||
├── lib/
|
├── lib/
|
||||||
│ ├── scheduler_core.dart
|
│ ├── scheduler_core.dart
|
||||||
│ └── src/
|
│ └── src/
|
||||||
|
│ ├── backlog.dart
|
||||||
|
│ ├── child_tasks.dart
|
||||||
|
│ ├── document_mapping.dart
|
||||||
|
│ ├── locked_time.dart
|
||||||
│ ├── models.dart
|
│ ├── models.dart
|
||||||
|
│ ├── persistence_contract.dart
|
||||||
|
│ ├── quick_capture.dart
|
||||||
|
│ ├── repositories.dart
|
||||||
│ ├── scheduling_engine.dart
|
│ ├── scheduling_engine.dart
|
||||||
│ └── task_statistics.dart
|
│ ├── task_actions.dart
|
||||||
|
│ ├── task_statistics.dart
|
||||||
|
│ └── timeline_state.dart
|
||||||
├── test/
|
├── test/
|
||||||
│ └── scheduling_engine_test.dart
|
│ ├── child_tasks_test.dart
|
||||||
|
│ ├── document_mapping_test.dart
|
||||||
|
│ ├── edge_case_regression_test.dart
|
||||||
|
│ ├── persistence_edge_cases_test.dart
|
||||||
|
│ ├── repositories_test.dart
|
||||||
|
│ ├── required_task_actions_test.dart
|
||||||
|
│ ├── scheduling_engine_test.dart
|
||||||
|
│ ├── surprise_task_logging_test.dart
|
||||||
|
│ └── timeline_state_test.dart
|
||||||
├── Human Documentation/
|
├── Human Documentation/
|
||||||
|
│ ├── Original Chat-Compiled Design Spec.md
|
||||||
│ ├── Overall App Design Spec.docx
|
│ ├── Overall App Design Spec.docx
|
||||||
│ └── Original Chat-Compiled Design Spec.md
|
│ ├── Starter Architecture Notes.md
|
||||||
|
│ └── Unified Product Design Summary.md
|
||||||
└── Codex Documentation/
|
└── Codex Documentation/
|
||||||
├── README.md
|
├── README.md
|
||||||
├── Current Software Plan/
|
├── Current Software Plan/
|
||||||
|
|
@ -42,16 +70,18 @@ The repository intentionally starts with a **pure Dart scheduling core** before
|
||||||
|
|
||||||
## Basic commands
|
## Basic commands
|
||||||
|
|
||||||
Install a Dart SDK that satisfies `pubspec.yaml` first. This starter is a pure
|
Install a Dart SDK that satisfies `pubspec.yaml` first. This is a pure Dart
|
||||||
Dart package, so Flutter is not required for the current core/test loop. MongoDB
|
package, so Flutter is not required for the current core/test loop. MongoDB is
|
||||||
is the planned persistence target, but no MongoDB service, Atlas account,
|
the planned persistence target, but no MongoDB service, Atlas account,
|
||||||
connection string, network access, or sync/background process is required for
|
connection string, network access, or sync/background process is required for the
|
||||||
the current in-memory domain/test loop.
|
current in-memory domain/test loop.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
dart pub get
|
dart pub get
|
||||||
|
dart format lib test
|
||||||
dart analyze
|
dart analyze
|
||||||
dart test
|
dart test
|
||||||
|
git diff --check
|
||||||
```
|
```
|
||||||
|
|
||||||
Run these before committing changes whenever the local environment has Dart
|
Run these before committing changes whenever the local environment has Dart
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue