eidosmd 0.1.0 → 0.2.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/README.md +50 -29
- package/browser/dist/assets/index-C2NMN_D4.css +1 -0
- package/browser/dist/assets/index-C65k1ihb.js +46 -0
- package/browser/dist/favicon.svg +5 -0
- package/browser/dist/index.html +15 -0
- package/browser/dist/mark.svg +4 -0
- package/dist/src/cli.js +7 -0
- package/dist/src/commands/agents.js +1 -1
- package/dist/src/commands/canvas.js +77 -0
- package/dist/src/commands/check.js +1 -1
- package/dist/src/commands/framework.js +24 -5
- package/dist/src/commands/index.js +4 -4
- package/dist/src/commands/init.js +1 -0
- package/dist/src/commands/instructions.js +1 -1
- package/dist/src/commands/list.js +8 -8
- package/dist/src/commands/migrate.js +32 -0
- package/dist/src/commands/new.js +3 -3
- package/dist/src/commands/seeds.js +5 -5
- package/dist/src/commands/setup.js +119 -0
- package/dist/src/commands/version.js +44 -0
- package/dist/src/commands/whoami.js +4 -4
- package/dist/src/context.js +5 -5
- package/dist/src/core/blueprint.js +16 -11
- package/dist/src/core/canvas-schema.js +148 -0
- package/dist/src/core/canvas.js +722 -0
- package/dist/src/core/check.js +127 -51
- package/dist/src/core/convert.js +7 -6
- package/dist/src/core/framework-markdown.js +113 -34
- package/dist/src/core/framework-model.js +27 -10
- package/dist/src/core/framework-structured.js +132 -33
- package/dist/src/core/framework.js +13 -13
- package/dist/src/core/git.js +59 -0
- package/dist/src/core/index-leaf.js +2 -2
- package/dist/src/core/me.js +16 -8
- package/dist/src/core/migrate.js +243 -0
- package/dist/src/core/naming.js +1 -1
- package/dist/src/core/root.js +2 -2
- package/dist/src/core/scaffold.js +19 -19
- package/dist/src/core/seed.js +151 -60
- package/dist/src/core/server.js +1236 -52
- package/dist/src/core/settings.js +181 -0
- package/dist/src/core/store.js +259 -0
- package/dist/src/core/template.js +32 -0
- package/dist/src/core/versions.js +79 -0
- package/dist/src/output.js +4 -1
- package/dist/src/program.js +134 -39
- package/instructions/authoring.md +13 -12
- package/instructions/configuring.md +65 -34
- package/instructions/init-required.md +4 -4
- package/instructions/overview.md +17 -7
- package/instructions/validating.md +5 -4
- package/package.json +21 -12
- package/standard/EIDOS.md +129 -188
- package/standard/seeds/README.md +6 -6
- package/standard/seeds/book/Framework.yaml +81 -0
- package/standard/seeds/book/README.md +9 -5
- package/standard/seeds/book/_gitignore +3 -3
- package/standard/seeds/book/me.md +1 -1
- package/standard/seeds/book/roles/README.md +3 -3
- package/standard/seeds/book/roles/framework-owner.md +2 -2
- package/standard/seeds/book/{shapes → templates}/chapter.full.md +0 -8
- package/standard/seeds/book/{shapes → templates}/chapter.sketch.md +0 -7
- package/standard/seeds/book/{shapes → templates}/frame.market.md +0 -6
- package/standard/seeds/book/templates/frame.premise.md +17 -0
- package/standard/seeds/book/{shapes → templates}/frame.reader.md +0 -6
- package/standard/seeds/book/{shapes → templates}/frame.voice.md +0 -7
- package/standard/seeds/research/Framework.yaml +81 -0
- package/standard/seeds/research/README.md +9 -5
- package/standard/seeds/research/_gitignore +3 -3
- package/standard/seeds/research/me.md +1 -1
- package/standard/seeds/research/roles/README.md +3 -3
- package/standard/seeds/research/roles/framework-owner.md +2 -2
- package/standard/seeds/research/{shapes → templates}/frame.ethics.md +0 -6
- package/standard/seeds/research/{shapes → templates}/frame.method.md +0 -7
- package/standard/seeds/research/{shapes → templates}/frame.prior-work.md +0 -6
- package/standard/seeds/research/{shapes → templates}/frame.question.md +0 -7
- package/standard/seeds/research/{shapes → templates}/investigation.full.md +0 -8
- package/standard/seeds/research/{shapes → templates}/investigation.note.md +0 -7
- package/standard/seeds/software/Framework.yaml +82 -0
- package/standard/seeds/software/README.md +5 -5
- package/standard/seeds/software/_gitignore +3 -3
- package/standard/seeds/software/me.md +1 -1
- package/standard/seeds/software/roles/README.md +3 -3
- package/standard/seeds/software/roles/framework-owner.md +2 -2
- package/standard/seeds/software/roles/project-manager.md +2 -2
- package/standard/seeds/software/roles/stakeholder.md +1 -1
- package/standard/seeds/software/{shapes → templates}/frame.architecture.md +0 -7
- package/standard/seeds/software/{shapes → templates}/frame.audience.md +1 -8
- package/standard/seeds/software/{shapes → templates}/frame.criteria.md +0 -8
- package/standard/seeds/software/{shapes → templates}/frame.market.md +0 -8
- package/standard/seeds/software/{shapes → templates}/spec.full.md +0 -8
- package/standard/seeds/software/{shapes → templates}/spec.micro.md +0 -9
- package/browser/index.html +0 -268
- package/dist/src/commands/convert.js +0 -30
- package/dist/src/core/shape.js +0 -26
- package/standard/seeds/book/Framework.md +0 -87
- package/standard/seeds/book/shapes/frame.premise.md +0 -24
- package/standard/seeds/research/Framework.md +0 -88
- package/standard/seeds/software/Framework.md +0 -88
- /package/standard/seeds/software/{shapes → templates}/.gitkeep +0 -0
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
# The Eidos version this framework targets; migrate reads and bumps it.
|
|
3
|
-
eidos_version: 4.5.0
|
|
4
|
-
# How files, folders, and links are named: kebab-case | TitleCase | Title Case. Absent = kebab-case.
|
|
5
|
-
naming: kebab-case
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Framework
|
|
9
|
-
|
|
10
|
-
The framework's index and config, in one place: the version and naming convention above, and below the
|
|
11
|
-
Top-Level documents, the Collections (with their flavors and grouping), and the property Schema. The
|
|
12
|
-
visible `README.md` at the root is the friendly door to it; keep it current with the
|
|
13
|
-
`configure` skill.
|
|
14
|
-
|
|
15
|
-
## Top-Level
|
|
16
|
-
|
|
17
|
-
<!-- configure: top-level index (regenerated) -->
|
|
18
|
-
- [README](../README.md) — the root's front door: what this programme asks, and pointers in.
|
|
19
|
-
<!-- One bullet per top-level document. README is the door and comes first; add your own below (a
|
|
20
|
-
Protocol, a Data Statement, the generated Blueprint Map canvas), each a link and a one-line
|
|
21
|
-
description. The framing docs live in the Frames collection, not here. configure refreshes
|
|
22
|
-
this list. -->
|
|
23
|
-
|
|
24
|
-
## Collections
|
|
25
|
-
|
|
26
|
-
A collection is a top-level folder of repeated blueprints that share a body shape. `Frames` holds the
|
|
27
|
-
framing docs — the most primary thing the folder says about itself — and `Investigations` the
|
|
28
|
-
programme's units. Add more with `configure`. Each lists its flavors (the default marked), how
|
|
29
|
-
it draws on the canvas, and its grouping, and points at its generated `index.md` leaf.
|
|
30
|
-
|
|
31
|
-
### Frames
|
|
32
|
-
|
|
33
|
-
The framing docs that set what every investigation is judged against — what is being asked, what is
|
|
34
|
-
already known, what would count as knowing, and who is affected. This framework's framing collection;
|
|
35
|
-
each frame follows the flavor of its kind, and one left unwritten is a gap to surface, not a failure.
|
|
36
|
-
|
|
37
|
-
- **Leaf:** [Frames/index.md](../Frames/index.md)
|
|
38
|
-
- **Flavors:**
|
|
39
|
-
- [question](shapes/frame.question.md) — what the programme asks, and why it matters (default).
|
|
40
|
-
- [prior work](shapes/frame.prior-work.md) — what is already known, and where this sits.
|
|
41
|
-
- [method](shapes/frame.method.md) — how anyone would know, and the standard of evidence.
|
|
42
|
-
- [ethics](shapes/frame.ethics.md) — who is affected, what they consented to, what could go wrong.
|
|
43
|
-
- **Canvas:** file
|
|
44
|
-
|
|
45
|
-
### Investigations
|
|
46
|
-
|
|
47
|
-
The programme's units, one per line of inquiry, grouped by strand.
|
|
48
|
-
|
|
49
|
-
- **Leaf:** [Investigations/index.md](../Investigations/index.md)
|
|
50
|
-
- **Flavors:**
|
|
51
|
-
- [full](shapes/investigation.full.md) — the complete investigation shape (default).
|
|
52
|
-
- [note](shapes/investigation.note.md) — Intent, Open Questions, Claims, Out of Scope; grow into full.
|
|
53
|
-
- **Canvas:** card from `## Intent`
|
|
54
|
-
- **Strands:** _(add one bullet per strand — a name and a short description — as strands accrue)_
|
|
55
|
-
|
|
56
|
-
## Schema
|
|
57
|
-
|
|
58
|
-
The property contract — what a blueprint's frontmatter may carry, across every collection. Two parts: the
|
|
59
|
-
**core** properties Eidos's own machinery uses, and the **custom** ones you (or the seed) add. Every
|
|
60
|
-
custom property declares which collections it **applies to** — `all`, or a list — so a property never
|
|
61
|
-
lands where it makes no sense (`strand` is Investigations-only). A property's type comes from the
|
|
62
|
-
Obsidian set (Text, List, Number, Checkbox, Date, Date & time), so frontmatter renders natively in an
|
|
63
|
-
Obsidian vault. The `configure` skill edits this section.
|
|
64
|
-
|
|
65
|
-
### Eidos Core
|
|
66
|
-
|
|
67
|
-
_Present on every blueprint. Managed by the standard (Eidos 4.5.0); `migrate` rewrites this block on a version change — don't hand-edit it. (`flavor` absent = the collection's default; `connects_to` absent = no canvas edges; a missing `summary` is flagged by the index.)_
|
|
68
|
-
|
|
69
|
-
| Name | Type | Meaning |
|
|
70
|
-
| ----------- | ---- | ---------------------------------------------------------------------------------------------- |
|
|
71
|
-
| id | Text | Stable, unique, kebab-case identity. Assigned once, never renamed. References point at it. |
|
|
72
|
-
| title | Text | Human-readable name. |
|
|
73
|
-
| summary | Text | One plain line — what this blueprint is, in a sentence, distilled from Intent. Source for the collection index.md listing; absent, the index flags it. |
|
|
74
|
-
| flavor | Text | Which body flavor this blueprint follows, from its collection's declared flavors. Absent = the collection's default flavor. |
|
|
75
|
-
| connects_to | List | Blueprints this one connects to on the canvas, each a markdown link; drawn as a directed edge (this → target). The intentional map, distinct from depends_on. |
|
|
76
|
-
|
|
77
|
-
### Custom Properties
|
|
78
|
-
|
|
79
|
-
_Yours to shape with the `configure` skill. The seed ships a few useful defaults below — keep, scope, or drop any of them; Eidos doesn't depend on them. Absence where a property applies is a soft gap the validator notes, never refuses._
|
|
80
|
-
|
|
81
|
-
| Name | Type | Applies To | Meaning |
|
|
82
|
-
| ------------- | ---- | -------------- | -------------------------------------------------------------------------------------- |
|
|
83
|
-
| status | Text | all | Lifecycle value: Draft / Open / Running / Answered / Inconclusive / Abandoned. An off-list value warns. |
|
|
84
|
-
| date_created | Date | all | YYYY-MM-DD. The day the blueprint was first written. Set once. |
|
|
85
|
-
| date_modified | Date | all | YYYY-MM-DD. The day the blueprint was last changed. |
|
|
86
|
-
| tags | List | all | Free tags. |
|
|
87
|
-
| strand | Text | Investigations | The grouping — the line of inquiry this belongs to, matching the blueprint's sub-folder in the naming convention. An unknown value warns, never fails. |
|
|
88
|
-
| depends_on | List | Investigations | Investigations, data, or approvals this one needs first, each a markdown link. A real dependency, not a canvas edge. |
|
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
# The Eidos version this framework targets; migrate reads and bumps it.
|
|
3
|
-
eidos_version: 4.5.0
|
|
4
|
-
# How files, folders, and links are named: kebab-case | TitleCase | Title Case. Absent = kebab-case.
|
|
5
|
-
naming: kebab-case
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Framework
|
|
9
|
-
|
|
10
|
-
The framework's index and config, in one place: the version and naming convention above, and below the
|
|
11
|
-
Top-Level documents, the Collections (with their flavors and grouping), and the property Schema. The
|
|
12
|
-
visible `README.md` at the root is the friendly door to it; keep it current with the
|
|
13
|
-
`configure` skill.
|
|
14
|
-
|
|
15
|
-
## Top-Level
|
|
16
|
-
|
|
17
|
-
<!-- configure: top-level index (regenerated) -->
|
|
18
|
-
- [README](../README.md) — the root's front door: what this is, and pointers in.
|
|
19
|
-
<!-- One bullet per top-level document. README is the door and comes first; add your own below (a
|
|
20
|
-
Roadmap, a Vision, the generated Blueprint Map canvas), each a link and a one-line description.
|
|
21
|
-
The framing docs live in the Frames collection, not here. configure refreshes this list. -->
|
|
22
|
-
|
|
23
|
-
## Collections
|
|
24
|
-
|
|
25
|
-
A collection is a top-level folder of repeated blueprints that share a body shape. `Frames` holds the
|
|
26
|
-
framing docs — the most primary thing the folder says about itself — and `Specs` the product's
|
|
27
|
-
units. Add more with `configure`. Each lists its flavors (the default marked) and its grouping,
|
|
28
|
-
and points at its generated `index.md` leaf.
|
|
29
|
-
|
|
30
|
-
### Frames
|
|
31
|
-
|
|
32
|
-
The framing docs that set what every other blueprint is judged against — the product's architecture,
|
|
33
|
-
audience, criteria, and market. This framework's framing collection; each frame follows the flavor of
|
|
34
|
-
its kind, and one left unwritten is a gap to surface, not a failure.
|
|
35
|
-
|
|
36
|
-
- **Leaf:** [Frames/index.md](../Frames/index.md)
|
|
37
|
-
- **Flavors:**
|
|
38
|
-
- [architecture](shapes/frame.architecture.md) — the product as a built system (default).
|
|
39
|
-
- [audience](shapes/frame.audience.md) — who it serves, and how each kind differs.
|
|
40
|
-
- [criteria](shapes/frame.criteria.md) — budget, scope objectives, timeline.
|
|
41
|
-
- [market](shapes/frame.market.md) — landscape, positioning, and how it earns.
|
|
42
|
-
- **Canvas:** file
|
|
43
|
-
|
|
44
|
-
### Specs
|
|
45
|
-
|
|
46
|
-
The product's units, one per blueprint, grouped by domain.
|
|
47
|
-
|
|
48
|
-
- **Leaf:** [Specs/index.md](../Specs/index.md)
|
|
49
|
-
- **Flavors:**
|
|
50
|
-
- [full](shapes/spec.full.md) — the complete spec shape (default).
|
|
51
|
-
- [micro](shapes/spec.micro.md) — Intent, Open Questions, ACs, Out of Scope; grow into full.
|
|
52
|
-
- **Canvas:** card from `## Intent`
|
|
53
|
-
- **Domains:** _(add one bullet per domain — a name and a short description — as domains accrue)_
|
|
54
|
-
|
|
55
|
-
## Schema
|
|
56
|
-
|
|
57
|
-
The property contract — what a blueprint's frontmatter may carry, across every collection. Two parts: the
|
|
58
|
-
**core** properties Eidos's own machinery uses, and the **custom** ones you (or the seed) add. Every
|
|
59
|
-
custom property declares which collections it **applies to** — `all`, or a list — so a property never
|
|
60
|
-
lands where it makes no sense (`domain` is Specs-only). A property's type comes from the Obsidian set
|
|
61
|
-
(Text, List, Number, Checkbox, Date, Date & time), so frontmatter renders natively in an Obsidian
|
|
62
|
-
vault. The `configure` skill edits this section.
|
|
63
|
-
|
|
64
|
-
### Eidos Core
|
|
65
|
-
|
|
66
|
-
_Present on every blueprint. Managed by the standard (Eidos 4.5.0); `migrate` rewrites this block on a version change — don't hand-edit it. (`flavor` absent = the collection's default; `connects_to` absent = no canvas edges; a missing `summary` is flagged by the index.)_
|
|
67
|
-
|
|
68
|
-
| Name | Type | Meaning |
|
|
69
|
-
| ----------- | ---- | ---------------------------------------------------------------------------------------------- |
|
|
70
|
-
| id | Text | Stable, unique, kebab-case identity. Assigned once, never renamed. References point at it. |
|
|
71
|
-
| title | Text | Human-readable name. |
|
|
72
|
-
| summary | Text | One plain line — what this blueprint is, in a sentence, distilled from Intent. Source for the collection index.md listing; absent, the index flags it. |
|
|
73
|
-
| flavor | Text | Which body flavor this blueprint follows, from its collection's declared flavors. Absent = the collection's default flavor. |
|
|
74
|
-
| connects_to | List | Blueprints this one connects to on the canvas, each a markdown link; drawn as a directed edge (this → target). The intentional map, distinct from depends_on. |
|
|
75
|
-
|
|
76
|
-
### Custom Properties
|
|
77
|
-
|
|
78
|
-
_Yours to shape with the `configure` skill. The seed ships a few useful defaults below — keep, scope, or drop any of them; Eidos doesn't depend on them. Absence where a property applies is a soft gap the validator notes, never refuses._
|
|
79
|
-
|
|
80
|
-
| Name | Type | Applies To | Meaning |
|
|
81
|
-
| ------------- | ---- | ---------- | ------------------------------------------------------------------------------------------ |
|
|
82
|
-
| status | Text | all | Lifecycle value: Draft / Intake / In Progress / Done / Archived / Deprecated. An off-list value warns. |
|
|
83
|
-
| date_created | Date | all | YYYY-MM-DD. The day the blueprint was first written. Set once. |
|
|
84
|
-
| date_modified | Date | all | YYYY-MM-DD. The day the blueprint was last changed. |
|
|
85
|
-
| tags | List | all | Free tags. |
|
|
86
|
-
| domain | Text | Specs | The grouping, matching the blueprint's sub-folder under its collection in the naming convention. An unknown value warns, never fails. |
|
|
87
|
-
| depends_on | List | Specs | Blueprints this one needs, each a markdown link. An implementation dependency, not a canvas edge. |
|
|
88
|
-
| type | Text | Specs | Open, soft category label — drives views and filtering, never structure. e.g. feature, capability, integration. |
|
|
File without changes
|