Skip to content

Latest commit

 

History

History
111 lines (94 loc) · 5.28 KB

README.md

File metadata and controls

111 lines (94 loc) · 5.28 KB

Plans index

Forward-looking specs for lingo. One numbered markdown per topic. Plans are living specs: when implementation forces a change, update the plan in the same change. Plans hold specs only — grammar, alias tables, ambiguity policy, API shapes. History belongs in git and packages/lingo/CHANGELOG.md; durable "how it works now" prose belongs in wiki/. A plan whose work is fully shipped and whose content is covered by wiki/code gets deleted, and its number retired (numbers are stable once assigned, never reused).

Conventions

  • Filename: NNN-kebab-title.md — three digits, stable once assigned. Next free number: 035.
  • Frontmatter: id, title, status, created, updated. New plans (since 2026-07-04) also carry:
    • goal: — one-sentence done state.
    • success_criteria: — 1–4 terse pass/fail outcomes, each written as "<measurable outcome> -> <proof artifact>" (test name, script, report path, terminal output). When a criterion is settled, annotate it in place: [MET: …] / [SKIPPED: … + why].
  • Status lifecycle: draft → approved → in-progress → done, plus deferred (intentionally on hold — reason in the body) and superseded (link the successor). A short free-text note after an em dash is welcome and normal: done — shipped 2026-07-04 (D20). If you need a status not on this list, add it here in the same change; otherwise the table is unfilterable.
  • Progress lives in body checklists, not frontmatter percentages — a single percentage tends to be both inaccurate and unmaintained.
  • Tangential ideas surfaced mid-task go to backlog.md — append, don't act.
  • Big design decisions inside a plan get a (locked-in YYYY-MM-DD) marker on their heading; API sketches are real TypeScript signatures in fenced blocks, not prose.

Plan anatomy (template for new plans)

---
id: NNN
title: <Human title>
status: draft
created: YYYY-MM-DD
updated: YYYY-MM-DD
goal: "<one-sentence done state>"
success_criteria:
  - "<measurable outcome> -> <proof artifact>"
---

# <Title>

Driver: <the user need, review finding, or decision that motivates this — link it>

## Design principle
<!-- the one idea that settles arguments during implementation -->

## Design (locked-in YYYY-MM-DD)
<!-- real TS signatures for anything public; alias tables; grammar rules -->

## Changes
<!-- numbered, by module -->

## Non-goals
<!-- what this plan deliberately does not do -->

## Open questions
<!-- decisions still owed, and by whom -->

## Acceptance
<!-- which gates prove it done: bun run check, corpus class, eval gates, budgets -->

Index

# Plan Status
000 Vision & scope approved
001 Architecture approved
002 Number parsing approved
003 Unit registry & conversion approved
004 Quantity grammar approved
005 Dates & durations approved
006 Fuzzy language approved
007 Formatting & humanization approved
008 DOM input & masking approved
009 Errors & suggestions approved
010 Testing strategy approved
011 Packaging, DX & release approved
012 Agent & LLM friendliness done
013 i18n roadmap in-progress
014 Strictness, acceptance & error escalation approved
018 Performance benchmarking in-progress — browser suites + CI posture pending
019 AI structured output & agent form filling done
020 Tool-boundary safety defaults (/ai v2) done
021 MCP integration in-progress — phases 1–2 shipped; phase 3 demo server optional
024 Ecosystem integration & docs enrichment done
025 Schema clarity & DX (wire v3) done
026 Currency done
027 Type inference done
028 Resource-style output done
029 Schema reference & adapters in-progress
030 Time-of-day, timezones & slots done
031 Ranked completions (autocomplete anything) approved
031 Locale packs in-progress
032 Input calculations (quantity arithmetic) done — shipped 2026-08-22 (D73)
033 Locale idiom coverage in-progress — waves 1–2 shipped (D68/D69/D70)
034 React Native text input done

Retired numbers (plans deleted after shipping; content lives in wiki/code): 015–017, 022–023.

Parking lot: backlog.md — ideas with no number yet.