Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

feat(framework): adopt the OKF frontmatter vocabulary in aidd_docs

Đang mở
  • Có gì không ổn?
#318 1 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, yaml
Lĩnh vực
documentation

Hướng nghiên cứu

Start by inventorying the artifacts under aidd_docs/, especially specs, PRDs, and memory, and compare their existing frontmatter with the listed OKF fields. Determine which fields have no equivalent, then define the required index.md for each directory. Done means foreign-facing artifacts use the vocabulary and every aidd_docs/ directory has an index; the named external-consumer criterion is currently blocked because no OKF reader exists.

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

Mô tả

Problem

Artifacts under aidd_docs/ carry ad-hoc frontmatter (objective, status) with no shared vocabulary, and no directory describes itself. An agent that did not write them cannot tell what they are.

The Open Knowledge Format is a candidate vocabulary. Checked against the Google Cloud announcement: OKF is directories of markdown files with YAML frontmatter, plus one index.md per directory. Each document carries type, title, description, resource, tags, timestamp. Vendor-neutral, no SDK.

So the framework already has the format — markdown with YAML frontmatter, everywhere. What it lacks is the shared vocabulary and the index.

Scope

  • Map the OKF fields onto what AIDD artifacts already carry, and name the ones with no equivalent.
  • Adopt the vocabulary in the artifacts a foreign agent would consume: specs, PRDs, memory.
  • Emit an index.md per aidd_docs/ directory.

Acceptance criteria

  • Every artifact a foreign agent would read carries the OKF fields.
  • A directory under aidd_docs/ describes itself through its index.md.
  • A named tool, outside AIDD, reads one of our artifacts and understands it.

Blocked: no consumer

No OKF reader exists in the AIDD ecosystem today. This buys interoperability with tools nobody has named. The last acceptance criterion is deliberately unsatisfiable right now — that is the point. Priority stays Low until a real consumer appears, and closing this issue is a defensible alternative to doing it.

Ngôn ngữ chính
TypeScript
Star
481
Fork
45
Merge trung bình
18 giờ 48 phút
Pull request đã merge (30 ngày)
111

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

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 ai-driven-dev/framework

Tất cả issue của ai-driven-dev/framework

Issue tương tự

Thêm issue về TypeScript

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.