eidosmd 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/browser/dist/assets/index-Cc3cNWHY.css +1 -0
- package/browser/dist/assets/index-DQgCQRa5.js +46 -0
- package/browser/dist/index.html +2 -2
- package/dist/src/commands/check.js +9 -3
- package/dist/src/commands/configure.js +201 -0
- package/dist/src/commands/framework.js +15 -4
- package/dist/src/commands/init.js +4 -0
- package/dist/src/commands/property.js +125 -0
- package/dist/src/commands/setup.js +24 -12
- package/dist/src/commands/version.js +2 -2
- package/dist/src/core/canvas.js +59 -49
- package/dist/src/core/check.js +101 -26
- package/dist/src/core/edits.js +1381 -0
- package/dist/src/core/framework-markdown.js +9 -3
- package/dist/src/core/framework-model.js +43 -8
- package/dist/src/core/framework-structured.js +104 -28
- package/dist/src/core/frontmatter.js +61 -1
- package/dist/src/core/git.js +28 -3
- package/dist/src/core/links.js +87 -0
- package/dist/src/core/markdown.js +16 -9
- package/dist/src/core/migrate.js +91 -15
- package/dist/src/core/regions.js +117 -0
- package/dist/src/core/scaffold.js +15 -9
- package/dist/src/core/seed.js +56 -31
- package/dist/src/core/server.js +204 -31
- package/dist/src/core/settings.js +63 -12
- package/dist/src/core/store.js +73 -17
- package/dist/src/core/versions.js +10 -5
- package/dist/src/program.js +296 -11
- package/instructions/authoring.md +4 -2
- package/instructions/configuring.md +27 -11
- package/instructions/overview.md +6 -4
- package/instructions/validating.md +6 -4
- package/package.json +1 -1
- package/standard/EIDOS.md +135 -193
- package/standard/seeds/README.md +12 -16
- package/standard/seeds/book/Framework.yaml +30 -50
- package/standard/seeds/book/README.md +2 -1
- package/standard/seeds/book/_gitignore +7 -1
- package/standard/seeds/research/Framework.yaml +30 -50
- package/standard/seeds/research/README.md +2 -1
- package/standard/seeds/research/_gitignore +7 -1
- package/standard/seeds/software/Framework.yaml +31 -51
- package/standard/seeds/software/README.md +2 -1
- package/standard/seeds/software/_gitignore +7 -1
- package/browser/dist/assets/index-C2NMN_D4.css +0 -1
- package/browser/dist/assets/index-C65k1ihb.js +0 -46
package/standard/EIDOS.md
CHANGED
|
@@ -1,265 +1,207 @@
|
|
|
1
1
|
# Eidos
|
|
2
2
|
|
|
3
|
-
**Version:** 5.
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
This file is the contract: the terms, the layout, and the rules. It names no collection,
|
|
8
|
-
|
|
9
|
-
##
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
20
|
-
| **
|
|
21
|
-
| **
|
|
22
|
-
| **
|
|
23
|
-
| **
|
|
24
|
-
| **
|
|
25
|
-
| **
|
|
26
|
-
| **
|
|
27
|
-
| **
|
|
28
|
-
|
|
29
|
-
A
|
|
3
|
+
**Version:** 5.3.0
|
|
4
|
+
|
|
5
|
+
Eidos is a way to define a product in markdown: an app, a book, a study, anything work produces that has a shape. The structure is data in a hidden folder that a tool can check against; the product is written in markdown against that structure. One file is the complete source of truth for one unit of the product, as true of something planned as of something long shipped.
|
|
6
|
+
|
|
7
|
+
This file is the contract: the terms, the layout, and the rules. It names no collection, template, or section; those belong to a framework.
|
|
8
|
+
|
|
9
|
+
## Terms
|
|
10
|
+
|
|
11
|
+
| Term | What it is |
|
|
12
|
+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
13
|
+
| **product** | What you are defining. |
|
|
14
|
+
| **framework** | How the files are organized: folders, templates, properties, vocabulary, roles. Lives in `.eidos/`; one framework can govern many products. |
|
|
15
|
+
| **root** | The folder it all lives in. Found by the `.eidos/` inside it, never by its name. |
|
|
16
|
+
| **folder** | A top-level folder in the root, declared with a type: `collection`, `assets`, or `other`. |
|
|
17
|
+
| **collection** | A folder of blueprints of one kind: specs, chapters, investigations. Its sub-folders, if any, are its declared groups. |
|
|
18
|
+
| **blueprint** | One markdown file in a collection, defining one unit of the product completely: properties on top, a body below. |
|
|
19
|
+
| **unit** | What one blueprint defines: a spec, a chapter, an investigation. Templates are named for it, singular. |
|
|
20
|
+
| **template** | The body a collection's blueprints follow: sections in order, under set names. Body only. One file per variant in `.eidos/templates/`. |
|
|
21
|
+
| **variant** | One of a collection's templates (`<unit>.<variant>.md`). One is the default; a blueprint on another says so in `variant`. |
|
|
22
|
+
| **property** | One frontmatter field: name, type, which collections it applies to, whether required, meaning, and options when closed. The whole table is the framework's Properties. |
|
|
23
|
+
| **vocabulary** | The framework's table of words used on purpose: what each means and what it is not. |
|
|
24
|
+
| **top-level doc** | A one-of-a-kind file at the root, listed in the framework document. No template; the body is never validated. |
|
|
25
|
+
| **role** | How an agent talks to one kind of person. `.eidos/me.md` says which role is in the seat. |
|
|
26
|
+
| **plugin** | A tool's own folder, `.eidos/plugins/<name>/`. The standard reads none of it. |
|
|
27
|
+
| **region** | A span in a markdown file that a tool owns, fenced by two HTML comments carrying its name. The standard reads none of it. |
|
|
28
|
+
|
|
29
|
+
A task describes work and dies when it ships. A blueprint describes the product and stays accurate for its whole life.
|
|
30
30
|
|
|
31
31
|
## Layout
|
|
32
32
|
|
|
33
|
-
The root is found by the hidden `.eidos/` inside it. It may be named anything; nothing points at it by path.
|
|
34
|
-
|
|
35
33
|
```txt
|
|
36
|
-
Blueprints/ # the root
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
34
|
+
Blueprints/ # the root; any name works, this is the default
|
|
35
|
+
.eidos/ # the framework
|
|
36
|
+
plugins/<name>/ # a tool's own folder; local.yaml inside it is personal (gitignored)
|
|
37
|
+
roles/<role>.md # response contracts; framework-owner.md is always one
|
|
38
|
+
templates/ # <unit>.<variant>.md, one per variant
|
|
39
|
+
.gitignore # ignores me.md and plugins/*/local.yaml
|
|
40
|
+
Framework.yaml # the framework document
|
|
41
|
+
me.md # who is in the seat (personal, gitignored)
|
|
42
|
+
<Assets>/ # type assets: files that are not markdown
|
|
43
|
+
<Collection>/ # type collection: blueprints
|
|
44
|
+
<Group>/ # a declared group; nothing deeper
|
|
41
45
|
<Title>.md # one blueprint per file
|
|
42
|
-
<
|
|
46
|
+
<Other>/ # type other: the owner's, described and left alone
|
|
47
|
+
<Doc>.md # a top-level doc, listed under top_level
|
|
43
48
|
```
|
|
44
49
|
|
|
45
|
-
|
|
50
|
+
**Everything at the root is declared.** A folder is `.eidos/` or declared under `folders`; a file is listed under `top_level`. Anything else is surfaced, and the owner declares it or moves it. Hidden entries (`.git`, `.obsidian/`) are the host's and exempt.
|
|
46
51
|
|
|
47
|
-
|
|
52
|
+
### Folders
|
|
48
53
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
roles/ # response contracts, committed and team-tunable
|
|
55
|
-
framework-owner.md # the role that holds intent, scope, and decisions
|
|
56
|
-
<role>.md # the rest are the framework's own
|
|
57
|
-
Framework.yaml # the framework document: version, naming, top-level docs, collections, properties, vocabulary, and the index
|
|
58
|
-
plugins/ # whatever tools keep in the framework, one folder each
|
|
59
|
-
<name>/ # a tool's own; the standard reads none of it
|
|
60
|
-
me.md # who is in the seat (personal, gitignored)
|
|
61
|
-
.gitignore # ignores me.md, and any personal file a plugin names
|
|
62
|
-
```
|
|
54
|
+
| Type | Holds | The standard |
|
|
55
|
+
| ------------ | -------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
56
|
+
| `collection` | blueprints, optionally in declared groups | generates, validates, and indexes the markdown files; ignores any other file |
|
|
57
|
+
| `assets` | files that are not markdown | reads nothing inside; the folder's name follows `naming`, the files keep their own |
|
|
58
|
+
| `other` | whatever the description says | reads nothing inside; the folder is declared and otherwise left alone |
|
|
63
59
|
|
|
64
|
-
|
|
60
|
+
A collection is flat or grouped. Grouped, every sub-folder is a declared group, and a group holds blueprints and nothing deeper. A grouping property's value is the group's name; an unknown value warns.
|
|
65
61
|
|
|
66
|
-
|
|
62
|
+
### Plugins
|
|
67
63
|
|
|
68
|
-
|
|
64
|
+
The top level of `.eidos/` is the standard's. A tool keeps what it needs in `.eidos/plugins/<name>/` and touches nothing else. The name is one identifier everywhere the tool appears (its folder, its Properties block, its regions): lowercase letters, digits, hyphens, unique in the root; `eidos` is reserved. A check never faults a plugin folder and a migration carries it across untouched. `local.yaml` inside it is one person's settings and is never committed.
|
|
69
65
|
|
|
70
66
|
### `Framework.yaml`
|
|
71
67
|
|
|
72
|
-
|
|
68
|
+
One per root, `Framework.yaml` or `.yml`, snake_case, comments welcome. Every path is relative to `.eidos/`.
|
|
73
69
|
|
|
74
70
|
```yaml
|
|
75
|
-
eidos_version: 5.
|
|
76
|
-
naming: kebab-case #
|
|
77
|
-
top_level:
|
|
78
|
-
- title:
|
|
79
|
-
|
|
80
|
-
description: the front door.
|
|
81
|
-
collections: # one entry per collection
|
|
71
|
+
eidos_version: 5.3.0
|
|
72
|
+
naming: kebab-case # kebab-case (default) | TitleCase | Title Case
|
|
73
|
+
top_level:
|
|
74
|
+
- { title: <Title>, path: ../<Doc>.md, description: one line }
|
|
75
|
+
folders:
|
|
82
76
|
- name: <Collection>
|
|
83
|
-
|
|
77
|
+
type: collection
|
|
78
|
+
description: one line
|
|
84
79
|
variants:
|
|
85
|
-
- { name: <variant
|
|
86
|
-
- { name: <variant-2>, template: templates/<unit>.<variant-2>.md, description: a lighter one to grow out of }
|
|
80
|
+
- { name: <variant>, template: templates/<unit>.<variant>.md, description: one line, default: true }
|
|
87
81
|
grouping:
|
|
88
82
|
label: <Grouping>
|
|
89
83
|
property: <name> # the custom property carrying the group, if one does
|
|
90
84
|
groups:
|
|
91
|
-
- { name: <Group>, description: one line
|
|
85
|
+
- { name: <Group>, description: one line }
|
|
86
|
+
- { name: <Assets>, type: assets, description: one line }
|
|
92
87
|
properties:
|
|
93
|
-
core: [] #
|
|
88
|
+
core: [] # the standard's; empty = the core for this eidos_version
|
|
94
89
|
custom:
|
|
95
|
-
- { name: <name>, type: Text, applies_to: all,
|
|
96
|
-
- { name: <name>, type: Text, applies_to: [<Collection>],
|
|
97
|
-
tools:
|
|
90
|
+
- { name: <name>, type: Text, applies_to: all, required: true, meaning: one line }
|
|
91
|
+
- { name: <name>, type: Text, applies_to: [<Collection>], options: [<Value>, <Value>], meaning: one line }
|
|
92
|
+
tools:
|
|
98
93
|
<tool>:
|
|
99
|
-
- { name: <name>, type: Text, applies_to: all, meaning:
|
|
100
|
-
vocabulary:
|
|
101
|
-
- { term: <Term>, means:
|
|
102
|
-
|
|
103
|
-
index: # generated, regenerated wholesale; never hand-edited
|
|
94
|
+
- { name: <name>, type: Text, applies_to: all, meaning: one line }
|
|
95
|
+
vocabulary:
|
|
96
|
+
- { term: <Term>, means: one line, not: ["<near-miss>, and why"], see: ../<Collection>/<Title>.md }
|
|
97
|
+
index: # generated; never hand-edited
|
|
104
98
|
<Collection>:
|
|
105
|
-
- { id: <id>, title: <Title>, summary: <
|
|
99
|
+
- { id: <id>, title: <Title>, summary: <summary>, path: <Group>/<Title>.md, group: <Group> }
|
|
106
100
|
```
|
|
107
101
|
|
|
108
|
-
- **`
|
|
109
|
-
- **`
|
|
110
|
-
- **`
|
|
111
|
-
- **`
|
|
112
|
-
- **`
|
|
113
|
-
- **`vocabulary`**: the root's own terms, one entry each: `term`, `means`, and `not` as a list, each item free to carry its clause, and `see` for the path to the blueprint that defines the term in full. Starts empty; absent means none declared.
|
|
114
|
-
- **`index`**: every collection's blueprints, generated (see [The index](#the-index)). Rebuilt wholesale by whatever indexes the root, which rewrites this key and nothing else; never hand-edited.
|
|
115
|
-
- Every path is relative to `.eidos/`; an index entry's `path` is relative to its collection folder.
|
|
116
|
-
|
|
117
|
-
### Templates and variants
|
|
102
|
+
- **`top_level`**: every file at the root, each a `title`, `path`, and `description`.
|
|
103
|
+
- **`folders`**: every folder at the root, each a `name`, `type`, and `description`. A `collection` also carries `variants` (`default` marks one; absent, the first is) and `grouping`. An unknown type is a fault.
|
|
104
|
+
- **`properties`**: one block per owner. `core` is the standard's, rewritten by a migration. `custom` is the owner's. `tools.<tool>` is that tool's alone. The six keys the standard names are the standard's; any other key on an entry is a tool's.
|
|
105
|
+
- **`vocabulary`**: the root's own terms. Starts empty.
|
|
106
|
+
- **`index`**: every collection's blueprints, rebuilt wholesale by whatever indexes the root, which touches no other key.
|
|
118
107
|
|
|
119
|
-
|
|
108
|
+
### Templates
|
|
120
109
|
|
|
121
|
-
|
|
110
|
+
A template is body only: sections in order, under set names, with guidance. Frontmatter in a template is a fault. The file is `<unit>.<variant>.md`, lowercase. A blueprint is validated against the variant it names; a lighter variant is never faulted for sections only a fuller one has.
|
|
122
111
|
|
|
123
112
|
### Properties
|
|
124
113
|
|
|
125
|
-
Each
|
|
126
|
-
|
|
127
|
-
**Applies To** scopes a property to collections: `all`, or a list. Frontmatter is generated per blueprint from the properties that apply to its collection, so a scoped property never lands where it makes no sense.
|
|
114
|
+
Each entry: `name`, `type`, `applies_to`, `required`, `meaning`, and `options` when the value is one of a closed set.
|
|
128
115
|
|
|
129
|
-
**
|
|
116
|
+
- **type** is one of Text, List, Number, Checkbox, Date, Date & time.
|
|
117
|
+
- **applies_to** is `all` or a list of collections.
|
|
118
|
+
- **required** (absent = `false`): a required property is generated into every new blueprint and surfaced when missing. An optional one is written when it has a value; its absence is never a gap.
|
|
119
|
+
- **options**: an ordered, non-empty list of allowed values, compared exactly. An off-list value is surfaced, never refused. An empty list is a fault. No default rides with it. `variant` and a grouping property take their sets from the structure and never carry `options`.
|
|
130
120
|
|
|
131
|
-
|
|
121
|
+
The block a property sits in owns it, and only the owner writes there. The core:
|
|
132
122
|
|
|
133
|
-
|
|
123
|
+
| Name | Type | Required | Meaning |
|
|
124
|
+
| --------- | ---- | -------- | ---------------------------------------------------------------------------- |
|
|
125
|
+
| `id` | Text | yes | Stable, unique identity, in any form. Assigned once, never changed. |
|
|
126
|
+
| `title` | Text | yes | Human-readable name. Rename freely; `id` holds still. |
|
|
127
|
+
| `summary` | Text | no | One line: what this blueprint is. Feeds the index; absent, the index flags it. |
|
|
128
|
+
| `variant` | Text | no | Which variant this blueprint follows. Absent = the collection's default. |
|
|
134
129
|
|
|
135
|
-
|
|
136
|
-
| --------- | ---- | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
137
|
-
| `id` | Text | Stable, unique identity, in any form: a slug, a number, a GUID. Assigned once, never changed. References point at it. |
|
|
138
|
-
| `title` | Text | Human-readable name. Rename it freely; `id` is what holds still. |
|
|
139
|
-
| `summary` | Text | One plain line: what this blueprint is. The source for the collection's [index](#the-index) listing; absent, the index flags it. |
|
|
140
|
-
| `variant` | Text | Which variant this blueprint follows. Absent = the collection's default. |
|
|
141
|
-
|
|
142
|
-
**Eidos defines no custom properties.** A lifecycle `status`, dates, a grouping, a dependency list, a relationship list — all are a framework's own choice, and how blueprints relate is better said in the body, as links in prose, than as a frontmatter field. Adding one means deciding all four of Name, Type, Applies To, and Meaning, then backfilling the blueprints it applies to.
|
|
130
|
+
Eidos defines no custom properties. Status, dates, grouping, dependencies: all the framework's choice.
|
|
143
131
|
|
|
144
132
|
### Vocabulary
|
|
145
133
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
Three layers of words meet in a root, and each is declared where it lives. The standard's terms are the table at the top of this file. A framework's structural names (its collections, variants, groups) are declared where the structure is. The root's own terms, the words the product itself is described in, are the framework's Vocabulary. **Eidos declares none of the last.** A Vocabulary starts empty and grows an entry when a word begins to carry a distinction worth keeping, each entry deciding all three of term, means, and not.
|
|
149
|
-
|
|
150
|
-
A declared term is the word (Rule 19). An agent authoring or checking a blueprint uses it, and where a near-miss appears says which term the Vocabulary would have, as a suggestion. This is distinct from what a role sets: a role is register, how deep an agent goes and what it surfaces for one kind of reader; the Vocabulary is meaning, what a word denotes for every reader.
|
|
134
|
+
Each entry: `term`, `means`, `not` (the near-misses and why each differs), and `see` when a blueprint defines it in full. Eidos declares none of a root's terms. Where a term is declared, blueprints use it; a near-miss is flagged with the term beside it, never swapped in silently.
|
|
151
135
|
|
|
152
136
|
### Roles
|
|
153
137
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
- **`.eidos/roles/<role>.md`** — one response contract per role: vocabulary and technical depth, what to surface versus fold away, and who holds which decisions. Which roles exist is the framework's call. Committed and team-tunable.
|
|
157
|
-
- **`.eidos/me.md`** — personal and gitignored, one per person. Names your role and calibrates it on three axes: **ownership**, **experience with the scope**, and **technical capacity**. Blank is fine.
|
|
158
|
-
|
|
159
|
-
One role every framework has: the **Framework Owner**, who holds the intent, the scope, and the decisions. The rest of the cast depends on the work.
|
|
138
|
+
`.eidos/roles/<role>.md` says how an agent responds to one kind of person: depth, what to surface, who decides. Every framework has a Framework Owner, who holds intent, scope, and decisions. `.eidos/me.md` names your role and calibrates it on ownership, experience with the scope, and technical capacity. Blank is fine.
|
|
160
139
|
|
|
161
140
|
## Writing
|
|
162
141
|
|
|
163
|
-
### `README.md`
|
|
164
|
-
|
|
165
|
-
A visible front door at the root: what the product is, and pointers into it — the top-level docs, the collections, and the framework document for the full index. Thin, orientation and links, edited in place.
|
|
166
|
-
|
|
167
142
|
### Naming
|
|
168
143
|
|
|
169
|
-
Everything a human reads in the tree
|
|
144
|
+
Everything a human reads in the tree follows `naming`. Absent means `kebab-case`.
|
|
170
145
|
|
|
171
|
-
| Convention | A blueprint file | A
|
|
172
|
-
| ------------------------ | ------------------------- |
|
|
173
|
-
| **kebab-case** (default) | `blueprint-title-here.md` | `group-name/`
|
|
174
|
-
| **TitleCase** | `BlueprintTitleHere.md` | `GroupName/`
|
|
175
|
-
| **Title Case** | `Blueprint Title Here.md` | `Group Name/`
|
|
146
|
+
| Convention | A blueprint file | A group folder | Trade |
|
|
147
|
+
| ------------------------ | ------------------------- | -------------- | -------------------------------------- |
|
|
148
|
+
| **kebab-case** (default) | `blueprint-title-here.md` | `group-name/` | readable everywhere, no `%20` |
|
|
149
|
+
| **TitleCase** | `BlueprintTitleHere.md` | `GroupName/` | space-free, capitalized |
|
|
150
|
+
| **Title Case** | `Blueprint Title Here.md` | `Group Name/` | reads like prose, `%20` in every link |
|
|
176
151
|
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
One convention governs the whole folder, and changing it later means renaming files, so it is settled at init. Whichever you pick: `.eidos/` is always lowercase; `README.md` keeps the name every tool already looks for; a grouping property's value matches its folder exactly; and fields meant for tools are not names in the tree.
|
|
152
|
+
Exceptions: `.eidos/` is lowercase, `README.md` keeps its name, a grouping value matches its folder exactly, and nothing inside an `assets` or `other` folder is held to the convention.
|
|
180
153
|
|
|
181
154
|
### Linking
|
|
182
155
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
```yaml
|
|
186
|
-
depends_on:
|
|
187
|
-
- "[Some Blueprint](../some-group/some-blueprint.md)"
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
If a target has no blueprint yet, name it plainly rather than fabricating a link.
|
|
156
|
+
A standard markdown link, path relative to the file it sits in, text the human title, `#heading` for a section. Properties that point outward hold links too, quoted in YAML. Files that are not blueprints are linked or embedded the same way (``): no wikilinks, no absolute paths, no resolution by filename. A check verifies the path resolves. If a target has no blueprint yet, name it plainly.
|
|
191
157
|
|
|
192
|
-
###
|
|
158
|
+
### Bodies
|
|
193
159
|
|
|
194
|
-
|
|
160
|
+
A blueprint's body follows its variant's template: keep the order and names, leave out a section that doesn't apply rather than leaving it empty, and write it like a person would read it. A top-level doc is loose prose, revised in place, with no template.
|
|
195
161
|
|
|
196
|
-
|
|
162
|
+
### Regions
|
|
197
163
|
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
Loose prose: record what is true now, revise when it changes. A top-level doc is one-of-a-kind, filled in once and edited in place, so it needs no shared template and gets none: a template earns its keep by being stamped again, and a document written once doesn't need a cookie-cutter. That is the whole difference from a blueprint, which follows a template, carries the frontmatter contract, and is validated, even in a collection the framework keeps as loose prose.
|
|
164
|
+
A tool keeps what it needs inside a markdown file between `<!-- <tool>:<region> <args> -->` and `<!-- /<tool>:<region> -->`, each alone on its line. `<args>` is optional `key=value` pairs. Inside is the tool's, rewritten wholesale; outside is the person's. A region closes at the first matching closer (`-->` or `--!>`); a marker inside a fenced code block is text. An opener with no closer is faulted; a region for an unknown tool never is. Frontmatter holds no regions.
|
|
201
165
|
|
|
202
166
|
## The index
|
|
203
167
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
**The index.** Every collection's blueprints, listed in the framework document under `index`, one list per collection, so a human or agent can find a blueprint without scraping the tree. Each entry is the blueprint's `id`, `title`, `summary` (null when absent, never invented), `path` relative to the collection folder, and `group` when it has one; entries are grouped by sub-folder when the collection has them, flat when it doesn't, in file order. Rebuilt by `index`, which rewrites that key and nothing else in the document.
|
|
207
|
-
|
|
208
|
-
**Any other view is a tool's.** A map, a graph, a report: a tool that draws one reads the index and the links in the bodies, keeps whatever it needs in its own Properties block or its `plugins/` folder, and writes its output as a top-level doc, registered under `top_level` like any other. The standard declares nothing for it.
|
|
168
|
+
The one derived view the standard defines. Every collection's blueprints, under `index`: `id`, `title`, `summary` (null when absent, never invented), `path` relative to the collection, and `group`. Grouped by group when the collection has them, in file order. Any other view is a tool's, written as a top-level doc.
|
|
209
169
|
|
|
210
170
|
## Rules
|
|
211
171
|
|
|
212
|
-
The
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
172
|
+
1. **The frontmatter is the agreement; the body is guidance.** Properties are checked. Sections are recommended.
|
|
173
|
+
2. **The root owns its framework.** A tool reads the framework from the root it is in, never from a copy of its own.
|
|
174
|
+
3. **Validation is framework-defined.** A check enforces that framework's Properties table, nothing hardcoded.
|
|
175
|
+
4. **Surface, never refuse.** A missing required property is added with a note; a missing section is offered. Never refuse the file.
|
|
176
|
+
5. **Write it like a human would read it.** If it reads like filled-in boilerplate, reshape it.
|
|
177
|
+
6. **Reference blueprints with links, not bare names,** in prose and properties alike. `id` sits behind the link.
|
|
178
|
+
7. **One template family per collection, as variants.** What flexes is which sections appear; never their order or names.
|
|
179
|
+
8. **Every property has a type, a meaning, and an owner.** Frontmatter is generated from the required ones, so a new blueprint is born conforming.
|
|
180
|
+
9. **Soft labels are views, not structure.** A category property drives filtering, never structure. `variant` carries the structural choice.
|
|
181
|
+
10. **A collection's grouping is its own.** Every sub-folder is a declared group; a group holds blueprints and nothing deeper.
|
|
182
|
+
11. **A template names its own stable part.** If the stable part changes substantially, ask whether this is a different blueprint.
|
|
183
|
+
12. **Non-goals carry the most weight.** Where a template has a section for what a blueprint will not do, that section is its strongest.
|
|
184
|
+
13. **A template documents its own conventions.** The standard governs folders, templates, variants, and properties; never a section.
|
|
185
|
+
14. **No work-tracking fields.** No sprint, estimate, or assignee; bridge to a tracker with a link. Intent, never progress.
|
|
186
|
+
15. **The Eidos version is a framework fact,** in `eidos_version`, never on a blueprint.
|
|
187
|
+
16. **Loose prose is revised in place.** That is revision, not work status.
|
|
188
|
+
17. **The human authors; the agent facilitates.** Intent, scope, and decisions stay with the person.
|
|
189
|
+
18. **Read `me.md` before acting,** then the role it names. Blank means full facilitation.
|
|
190
|
+
19. **A declared term is the word.** A near-miss is flagged, never swapped silently.
|
|
191
|
+
20. **A region is a tool's, by name.** Inside is the tool's; outside is the person's.
|
|
192
|
+
21. **Everything at the root is declared.** Every folder has a type, every file an entry, and nothing is declared that isn't there.
|
|
233
193
|
|
|
234
194
|
## Versioning
|
|
235
195
|
|
|
236
|
-
Semantic Versioning
|
|
237
|
-
|
|
238
|
-
This file holds the version of **the standard** — right now, **5.0.0** — and it moves only when the text of this file moves. A framework records the version it targets as `eidos_version` in its framework document; a migration reads and bumps it there. At tag time this file is copied as-is into `versions/` under its full semver name, so any two releases, even non-adjacent, can be diffed to migrate between them. Worked hops are in `versions/MIGRATIONS.md`. Tools may reject an unsupported version.
|
|
239
|
-
|
|
240
|
-
**Tools that ship this standard version separately.** A CLI, a plugin, a starting framework: each changes far more often than the standard does, so a release of one leaves this file — and every framework's `eidos_version` — untouched. When you need to know what a framework conforms to, read this version; a tool names the standard it carries.
|
|
196
|
+
Semantic Versioning. This file's version moves only when its text moves; a framework records the version it targets as `eidos_version`. Each release is frozen in `versions/` and the worked hops are in `versions/MIGRATIONS.md`. Tools ship their own version and may reject an unsupported standard.
|
|
241
197
|
|
|
242
198
|
## For an agent
|
|
243
199
|
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
**
|
|
247
|
-
|
|
248
|
-
**
|
|
249
|
-
|
|
250
|
-
**
|
|
251
|
-
|
|
252
|
-
**Speak the root's terms.** The framework's Vocabulary says which word is the word and what it is not. Use the declared term in what you write; where the owner's draft or speech uses a near-miss, say which term the Vocabulary declares and ask, rather than substituting silently. A word the owner keeps using that no row declares is worth naming as a candidate; declaring it is the owner's call.
|
|
253
|
-
|
|
254
|
-
**Navigate by the index.** `README.md` for orientation, then `.eidos/Framework.yaml`: its `top_level` and `collections` for what the root holds, its `index` for every collection's blueprints. Read it instead of scraping the tree; regenerate the index when stale.
|
|
255
|
-
|
|
256
|
-
**Authoring a blueprint:**
|
|
257
|
-
|
|
258
|
-
1. From the framework document, take the Properties table, the Vocabulary, the naming convention, and the target collection's variants. Pick a variant (the default unless the owner chooses another) and read its template for the body. Name the file for its title in the convention; put a permanent `id` inside, in whatever form the root uses.
|
|
259
|
-
2. Generate frontmatter from the properties that apply to that collection. Fill values from what the owner tells you; leave a property blank rather than guessing it.
|
|
260
|
-
3. Lead with the template's opening sections and press hardest on its non-goals section. Read those names off the template rather than assuming them, and follow whatever labeling it asks for. Omit a section that doesn't apply; keep the order and names of the ones that do.
|
|
261
|
-
4. Where the owner is vague, ask. Don't fill the gap with plausible prose.
|
|
262
|
-
|
|
263
|
-
**Validating a blueprint:** check frontmatter against the framework's Properties table, every block of it (`id` present and unique, dates as `YYYY-MM-DD`, custom and tool properties scoped to the collection). Report missing body sections against *the blueprint's variant template*, flagging an absent non-goals section first, and note anything skipping the labeling that template asks for. Note each near-miss the Vocabulary names, with the declared term beside it. Confirm no work-tracking fields crept in. Surface, don't block — the output is a review a human acts on.
|
|
264
|
-
|
|
265
|
-
**Facilitate, don't author.** Format and structure what the owner gives you, supplement, ask, and press on scope. Never invent a blueprint's purpose, decide direction, or hand back a finished blueprint to rubber-stamp. When unsure, ask.
|
|
200
|
+
- **Use the CLI when you have a shell.** Run `eidos instructions`. Without one, the Eidos skills stand in.
|
|
201
|
+
- **Find the root by `.eidos/`,** never by name. Read that framework; never assume a folder, section, or property name. Check `eidos_version` once per session; a gap is one line and an offer, never a block.
|
|
202
|
+
- **Read `me.md` first,** then the role file. Speak the root's declared terms.
|
|
203
|
+
- **Leave plugins and regions to their owners.** Carry them across as found; fault only an opener with no closer.
|
|
204
|
+
- **Navigate by the framework document,** not the tree: `top_level`, `folders`, `index`. Check the root against it and surface what is missing on either side; never invent a description, never delete a file.
|
|
205
|
+
- **Authoring:** take the Properties table, Vocabulary, naming, and the collection's variants; generate frontmatter from the required properties; follow the template's sections, pressing hardest on non-goals; where the owner is vague, ask.
|
|
206
|
+
- **Validating:** frontmatter against every block of the Properties table; body against the blueprint's variant; links resolve; no work-tracking fields; near-misses flagged. Surface, don't block.
|
|
207
|
+
- **Facilitate, don't author.** Never invent a blueprint's purpose or hand back a finished one to rubber-stamp.
|
package/standard/seeds/README.md
CHANGED
|
@@ -1,25 +1,21 @@
|
|
|
1
1
|
# Seeds
|
|
2
2
|
|
|
3
|
-
The starting
|
|
3
|
+
The starting frameworks Eidos ships. A seed is a complete `.eidos/` (templates, roles, `Framework.yaml`, `me.md`, `.gitignore`) plus a root `README.md`; `eidos init` installs the one you pick. Reshape it from there.
|
|
4
4
|
|
|
5
|
-
| Seed | For |
|
|
5
|
+
| Seed | For | Folders |
|
|
6
6
|
| --- | --- | --- |
|
|
7
|
-
| [`software/`](software) | a product, service, or system being built | `Frames` (architecture, audience, criteria, market) · `Specs` by domain |
|
|
8
|
-
| [`book/`](book) | a book, long-form argument, or course | `Frames` (premise, reader, voice, market) · `Chapters` by part |
|
|
9
|
-
| [`research/`](research) | a question, a study, or a programme of inquiry | `Frames` (question, prior work, method, ethics) · `Investigations` by strand |
|
|
10
|
-
|
|
11
|
-
Every seed carries the same pieces, so the `eidos` CLI works identically across them:
|
|
7
|
+
| [`software/`](software) | a product, service, or system being built | `Frames` (architecture, audience, criteria, market) · `Specs` by domain · `assets` |
|
|
8
|
+
| [`book/`](book) | a book, long-form argument, or course | `Frames` (premise, reader, voice, market) · `Chapters` by part · `assets` |
|
|
9
|
+
| [`research/`](research) | a question, a study, or a programme of inquiry | `Frames` (question, prior work, method, ethics) · `Investigations` by strand · `assets` |
|
|
12
10
|
|
|
13
11
|
```txt
|
|
14
12
|
<seed>/
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
.
|
|
20
|
-
README.md
|
|
13
|
+
roles/ # response contracts, one per role
|
|
14
|
+
templates/ # body templates, <unit>.<variant>.md
|
|
15
|
+
.gitignore # keeps me.md and plugins/*/local.yaml out of version control
|
|
16
|
+
Framework.yaml # the framework document
|
|
17
|
+
me.md # blank; who is in the seat (personal)
|
|
18
|
+
README.md # the {{Product}} front door, installed at the root
|
|
21
19
|
```
|
|
22
20
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
**None of these fit?** Start from the nearest and reshape it, or scaffold your own collections with the `eidos` CLI.
|
|
21
|
+
Nothing in Eidos knows a folder by name: `software` is the default, and the other two run the same machinery under different words. None fit? Start from the nearest and reshape it with the `eidos` CLI.
|