Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#318 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
markdown, yaml
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
TypeScript
スター
481
フォーク
45
平均マージ
18時間 31分
マージ済み PR(30日)
108

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ai-driven-dev/framework のほかの issue

ai-driven-dev/framework の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。