docs(design): status headers on several design docs no longer match the code

Aperta
  • Qualcosa non va?
#463 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
markdown, rust
Ambito
documentation

Direzione di ricerca

Read the listed files under docs/design/ and compare their status lines with the evidence named in the issue, including aimdb-core/src/record_id.rs and the persistence workspace members. Start by verifying the clear mismatches, then check the history for the items marked “worth a look.” Update statuses where verified; if 046 was withdrawn, add the suggested stub. Done when each changed status reflects evidence in the repository.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Problem

The **Status:** line at the top of each file in docs/design/ is the quickest way to tell whether a design shipped, but a number of them are out of date, which makes the whole set less trustworthy.

Clear mismatches:

Doc Status line Reality
015-M6-record-id-architecture.md "🚧 In Progress (Branch: 60-replace-typeid-storage-with-recordid-…)" aimdb-core/src/record_id.rs is in main; the branch reference is long dead
022-M10-persistence-backend.md "📋 Proposed" aimdb-persistence and aimdb-persistence-sqlite are shipped workspace members
031-M15-remove-latest-snapshot.md "🔵 Proposed" the title's removal appears to have happened (no latest_snapshot left in the user-facing docs)
020-M9-transform-api.md "🚧 In Progress" aimdb-core/src/transform/ exists and 027 (no_std transform API) is "Implemented"

Worth a look by someone who knows the history:

  • 016-M6-record-key-trait.md, 019-M8-record-history-api.md, 021-M9-graph-introspection.md — "Proposed"
  • 034-technical-debt-review.md, 035-review-followups-deferred.md, 036-followup-refactoring.md — "Draft", although 036 records implemented items and 038 supersedes much of 034
  • 044-embassy-mqtt-tls.md — "Implemented on feat/embassy-mqtt-tls-connector (hardware verification pending)"

Also: there is no 046-*.md; numbering jumps from 045 to 047. If 046 was withdrawn, a one-line stub would stop people looking for it.

Suggested work

  • Update the status lines above to the real state (Implemented / Superseded by NNN / Withdrawn).
  • Optionally agree on a fixed vocabulary for the status line; today it mixes emoji and free text ("RFC.", "proposal, revised …", "complete — …"), which makes it hard to grep.

Notes

Statuses were read from the first Status line of each doc at d9c7be0 and compared against what exists in the tree. For the "worth a look" group I did not verify whether the design was implemented.

Lingua principale
Rust
Stelle
101
Fork
20
Merge medio
2h 33m
PR unite (30g)
90

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aimdb-dev/aimdb

Tutte le issue di aimdb-dev/aimdb

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.