Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#318 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
markdown, yaml
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
481
Fork
45
Merge medio
18h 48m
PR unite (30g)
111

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ai-driven-dev/framework

Tutte le issue di ai-driven-dev/framework

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.