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

Abierto
  • ¿Algo no está bien?
#463 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, rust
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Rust
Estrellas
101
Forks
20
Merge medio
2 h 33 min
PR fusionados (30 d)
90

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aimdb-dev/aimdb

Todos los issues de aimdb-dev/aimdb

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.