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

未关闭
#463 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
markdown, rust
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Rust
星标
101
派生
20
平均合并
2 小时 33 分钟
30 天内合并 PR
90

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

aimdb-dev/aimdb 的其他 Issue

查看 aimdb-dev/aimdb 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。