Skip to content

[P3][doc-drift] DESIGN_REQUIREMENTS [done] flags on FR-1, FR-2, FR-3, FR-4, FR-6, FR-9 are inaccurate #459

Description

@EVWorth

Context

docs/design/DESIGN_REQUIREMENTS.md uses [done]/[partial]/[dropped] status flags per FR section. The doc-keeper sweep reconciles these flags against the actual code state.

Problem

The cross-cutting audit (docs/audits/cross-cutting.md F27) quantified the drift between flags and filed issues. Six FR sections marked [done] have multiple filed P0/P1 issues contradicting the flag:

FR Flag Contradicting issues
FR-1 Connection Management [done] #273 (SSH tunnel unimplemented), #274 (keyring wipe), #276 (no auto-reconnect backoff), #277 (read_only UI-only), #278 (init_keyring panic), #279 (pool stats), #280 (connect/disconnect race), #281 (no cancel_query)
FR-2 SQL Editor [done] #282 (Ctrl+. cancel missing), #283 (query_timeout unenforced), #284 (streaming not implemented), #285 (no params), #287 (cancel race), #295 (doc-drift meta)
FR-3 Data Grid [done] #391 (no filters/pagination), #392 (no column reorder/multi-sort), #401 (no BLOB preview), #402 (no row count), #403 (Set NULL menu missing), #406 (god-component), #410 (BIGINT corruption), #413 (truncation banner misleading), #414 (no column type indicators), #416 (selection & copy partial), #417 (ResizeObserver leak)
FR-4 Schema Browser [done] #288 (connection-switch leak), #289 (refresh broken), #290 (USE/SHOW CREATE on different connections), #291 (Events/drag/system-DB missing), #292 (object details partial), #293 (most context-menu ops missing)
FR-6 AI Features [done] #308 (multi-statement bypass), #309 (prompt injection), #310 (3 missing commands), #311 (ai_cancel doesn't kill server), #312 (read_only ignored), #313 (schema truncation), #314 (panic on .expect()), #315 (worker starvation), #316 (status always spins up), #317 (no rate limit), #318 (no eviction), #319 (Copilot SDK pinned)
FR-9 Query History & Favorites [done] #323 (cap 500 not 10K), #324 (error not recorded), #325 (no execute immediately), #326 (no filter), #327 (no remove UI), #328 (unknown connection on failure), #329 (multi-statement records single entry), #330 (raw SQL persisted), #331 (sync localStorage write), #332 (no dup validation), #333 (rename onBlur race), #334 (no hierarchical folders), #335 (no import/export), #336 (focus traps), #337 (no delete confirm), #338 (+New invisible), #339 (no scrubbing), #340 (god-component), #341 (no isDirty check), #342 (no Save as Favorite button)

That's 56+ filed issues contradicting the [done] flags. A doc PR is needed to flip each [done][partial] and cite the issue numbers.

The cross-cutting audit (docs/audits/cross-cutting.md F27) flagged this as P3 (convention/test/doc-drift). It's a single meta-issue that reconciles all status flags at once per the audit README.

Files

  • docs/design/DESIGN_REQUIREMENTS.md:197 (FR-1 [done])
  • docs/design/DESIGN_REQUIREMENTS.md:236 (FR-2 [done])
  • docs/design/DESIGN_REQUIREMENTS.md:280 (FR-3 [done])
  • docs/design/DESIGN_REQUIREMENTS.md:336 (FR-4 [done])
  • docs/design/DESIGN_REQUIREMENTS.md:413 (FR-6 [done])
  • docs/design/DESIGN_REQUIREMENTS.md:533 (FR-9 [done])

Repro

grep -nE "^### FR-.*\[done\]" docs/design/DESIGN_REQUIREMENTS.md
# Returns 6 sections (FR-1, FR-2, FR-3, FR-4, FR-6, FR-9)
# All contradict filed P0/P1 issues

Expected

After this PR, only FRs with ≥ 90% of acceptance criteria implemented keep the [done] flag. Sections with multiple unresolved P0/P1 issues show [partial] and cite the issue numbers in a small header note.

Proposed fix

Scope S. One PR that:

  1. Updates each [done][partial] for FR-1, FR-2, FR-3, FR-4, FR-6, FR-9.
  2. Adds a one-line header note citing the count of filed issues per section.
  3. Updates the FR-5 (already [partial]) header to cite the new audit: table designer #376/audit: routine viewer #390/audit: EXPLAIN visualizer #411 siblings.
  4. Leaves [dropped] on FR-10 unchanged.

Acceptance

grep -nE "^### FR-.*\[done\]" docs/design/DESIGN_REQUIREMENTS.md returns 0 hits (or only FRs with ≥ 90% of acceptance criteria implemented). Each remaining flag has a brief comment citing the issue tracker.

Needs human verify

Yes (doc change).

Labels: audit, area/cross-cutting, severity/p3, kind/doc-drift

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/cross-cuttingAudit areaauditTracks a feature-by-feature codebase audit findingkind/doc-driftAudit finding categoryseverity/p3Audit finding severity

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions