codexa 0.0.3

A Git-native content compiler for building typed public and private knowledge artifacts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

---
schema: codexa.document@2
id: codexa.reference.frontmatter
title: Codexa Frontmatter Reference
description: Required and optional YAML frontmatter fields for Codexa source documents.
kind: reference
status: active
visibility: public
tags:
  - codexa
  - frontmatter
  - yaml
  - schema
navigation:
  root: docs
  product: codexa
  section: Reference
  order: 20
distribution:
  notion: true
  web: public
  obsidian: true
notion:
  workspace: codexa
web:
  slug: /docs/codexa/reference/frontmatter
---

# Codexa Frontmatter Reference

Codexa frontmatter is YAML embedded at the beginning of a Markdown document. It is a versioned authoring contract, not endpoint configuration copied from Notion or a website.

## Complete example

```yaml
---
schema: codexa.document@2
id: codexa.guides.quick-start
title: Codexa Quick Start
description: Organize a repository and build endpoint artifacts.
kind: guide
status: active
visibility: public
tags:
  - codexa
  - quick-start
navigation:
  root: docs
  product: codexa
  section: Guides
  order: 10
distribution:
  notion: true
  web: public
  obsidian: true
notion:
  workspace: codexa
web:
  slug: /docs/codexa/guides/quick-start
---
```

## Required fields

`schema`
: Must be `codexa.document@2` during the current pre-`0.1.0` development contract.

`id`
: Stable, globally unique document identity. Links and endpoint registries use this value rather than the source filename.

`title`
: Human-facing page title.

`description`
: Short description used by endpoint indexes, search, previews, and metadata.

`kind`
: Content role such as `guide`, `concept`, `reference`, `operation`, `contract`, `playbook`, or `index`.

`status`
: Lifecycle state such as `draft`, `active`, or `archived`.

`visibility`
: Intended visibility such as `public`, `private`, or `unlisted`.

`navigation`
: Required tree placement. `root` identifies the major content tree, `product` identifies the repository or project subtree, `section` groups related pages, and `order` controls sorting.

`distribution`
: Enables or disables endpoint artifact generation.

## Conditional endpoint fields

When `distribution.notion` is `true`, provide:

```yaml
notion:
  workspace: codexa
```

When `distribution.web` is not `off`, provide an absolute site path:

```yaml
web:
  slug: /docs/codexa/reference/frontmatter
```

`distribution.obsidian` records whether the document is eligible for a future Obsidian export. Obsidian remains an endpoint; Git remains authoritative.

## Internal links

Use stable document IDs:

```md
[[codexa.guides.quick-start]]
[[orbexa.guides.quick-start|Orbexa Quick Start]]
```

See [[codexa.concepts.navigation-and-links|Navigation and Links]] for resolution behavior.

## Version policy

Before Codexa, Orbexa, and Loomara reach `0.1.0`, the three projects may move together through breaking contract changes. At `0.1.0`, the first public contract is frozen. Subsequent feature releases must account for compatibility and migration.