Ir para o conteúdo
Explorar a documentação

Markdown

As nove famílias de documentos usam um namespace de frontmatter YAML:

---
langdrift:
  type: prd
  schema_version: 1
  id: PRD-001
  title: Product Vision dashboard
  owners: [user_42]
  research: [RES-002]
  vision_targets: [VT-001]
---
 
# Product Vision dashboard
 
Rich Markdown context remains in the body.

O payload analisado é:

{
  metadata: ArtifactMetadata
  body: string
}

type, schema_version, id, title e owners são obrigatórios. Os IDs são strings não vazias sem espaços em branco; os responsáveis são identificadores, não perfis de usuário incorporados.

Os metadados estruturados opcionais incluem:

  • description, summary, status, scope e tags
  • deciders, questions e datas
  • listas de relações tipadas, como research, prds, specs e vision_targets
  • references, supersedes e superseded_by gerais
  • uma identidade de provedor em external

Campos desconhecidos dentro de langdrift são rejeitados. YAML na raiz, fora do namespace langdrift, não é metadado do protocolo e é ignorado por parseArtifact.

Regras do analisador

O delimitador de frontmatter deve iniciar o arquivo, exceto por uma marca de ordem de bytes UTF-8 opcional. O analisador rejeita YAML malformado, tags personalizadas, chaves duplicadas, aliases e metadados inválidos para o esquema.

O corpo começa imediatamente após o delimitador de fechamento. Unicode e quebras de linha originais são preservados, e o texto do corpo não é executado. Títulos, prosa e nomes de arquivos não fornecem identidade nem preenchem metadados ausentes. As relações também são extraídas apenas dos metadados estruturados.

Envelopes Record e Drift Event não usam esse invólucro Markdown. Eles são validados diretamente a partir de JSON.

Editar esta página no GitHub