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

Đang mở
  • Có gì không ổn?
#463 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, rust
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Rust
Star
101
Fork
20
Merge trung bình
2 giờ 33 phút
Pull request đã merge (30 ngày)
90

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của aimdb-dev/aimdb

Tất cả issue của aimdb-dev/aimdb

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.