Skip to content

Commit 207bb01

Browse files
committed
docs: analysis on new user input API [compy-toys#77]
Multiple iterations (LLM-assisted, strictly human-directed) over planned major architectural change. Result is a (supposedly coherent) set of documents for stakeholders review -- from requirements to design and spec/roadmap. (plus multiple cross-referenced notes supporting traceability and formal verification of suggested solution) Starting point: doc/development/wip/77-new-input-api/README.md
1 parent c8fde27 commit 207bb01

41 files changed

Lines changed: 10465 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Feature #77 — New Input API
2+
3+
**TL;DR:** a callback-based input API for projects, replacing the polling
4+
functions (`input_text`, `input_code`, `validated_input`, `user_input`). It
5+
turned out to touch keyboard routing across the whole app, not just the REPL —
6+
so it got a proper upfront analysis instead of a dive-in. **Complex, but
7+
solvable**, and pre-planned so building can start on a green light. Old
8+
functions keep working; nothing existing breaks.
9+
10+
## Start here
11+
12+
Read the **`summaries/`** folder — that's the whole feature at stakeholder
13+
altitude, ~30 min total. The one that needs your call is
14+
**`summaries/decisions.md`**.
15+
16+
| # | Summary | What it answers |
17+
|---|---|---|
18+
| 1 | `summaries/requirements.md` | What was asked for |
19+
| 2 | `summaries/assessment.md` | What the code does today |
20+
| 3 | `summaries/decisions.md`| The calls awaiting approve / veto |
21+
| 4 | `summaries/design.md` | How it works |
22+
| 5 | `summaries/spec.md` | The API contract |
23+
| 6 | `summaries/roadmap.md` | Build plan + effort (~35–59 h) |
24+
25+
## If you want to dig
26+
27+
- **Full docs** — same names in this folder (`decisions.md`, `design.md`, …),
28+
for when a summary isn't enough.
29+
- **`input.md`** — your ticket + clarification, verbatim.
30+
- **`notes/`** — supporting codebase analysis.
31+
- **`validation/`** — the review rounds and their fixes.

doc/development/wip/77-new-input-api/assessment.md

Lines changed: 377 additions & 0 deletions
Large diffs are not rendered by default.

doc/development/wip/77-new-input-api/decisions.md

Lines changed: 609 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)