stego-cli 0.3.4 → 0.4.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 +10 -0
- package/dist/metadata/metadata-command.js +127 -0
- package/dist/metadata/metadata-domain.js +209 -0
- package/dist/spine/spine-command.js +129 -0
- package/dist/spine/spine-domain.js +274 -0
- package/dist/stego-cli.js +187 -173
- package/package.json +3 -2
- package/projects/fiction-example/spine/characters/CHAR-AGNES.md +17 -0
- package/projects/fiction-example/spine/characters/CHAR-ETIENNE.md +17 -0
- package/projects/fiction-example/spine/characters/CHAR-MATTHAEUS.md +17 -0
- package/projects/fiction-example/spine/characters/CHAR-RAOUL.md +17 -0
- package/projects/fiction-example/spine/characters/_category.md +6 -0
- package/projects/fiction-example/spine/locations/LOC-CHARNEL.md +17 -0
- package/projects/fiction-example/spine/locations/LOC-COLLEGE.md +17 -0
- package/projects/fiction-example/spine/locations/LOC-HOTELDIEU.md +17 -0
- package/projects/fiction-example/spine/locations/LOC-QUAY.md +17 -0
- package/projects/fiction-example/spine/locations/_category.md +6 -0
- package/projects/fiction-example/spine/sources/SRC-CONJUNCTION.md +20 -0
- package/projects/fiction-example/spine/sources/SRC-GALEN.md +20 -0
- package/projects/fiction-example/spine/sources/SRC-WARD-DATA.md +20 -0
- package/projects/fiction-example/spine/sources/_category.md +6 -0
- package/projects/fiction-example/stego-project.json +1 -18
- package/projects/stego-docs/manuscript/500-project-configuration.md +3 -3
- package/projects/stego-docs/spine/commands/CMD-BUILD.md +11 -0
- package/projects/stego-docs/spine/commands/CMD-CHECK-STAGE.md +11 -0
- package/projects/stego-docs/spine/commands/CMD-EXPORT.md +11 -0
- package/projects/stego-docs/spine/commands/CMD-INIT.md +11 -0
- package/projects/stego-docs/spine/commands/CMD-LIST-PROJECTS.md +10 -0
- package/projects/stego-docs/spine/commands/CMD-NEW-PROJECT.md +10 -0
- package/projects/stego-docs/spine/commands/CMD-NEW.md +11 -0
- package/projects/stego-docs/spine/commands/CMD-VALIDATE.md +11 -0
- package/projects/stego-docs/spine/commands/_category.md +6 -0
- package/projects/stego-docs/spine/concepts/CON-COMPILE-STRUCTURE.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-DIST.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-MANUSCRIPT.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-METADATA.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-NOTES.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-PROJECT.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-SPINE-CATEGORY.md +11 -0
- package/projects/stego-docs/spine/concepts/CON-SPINE.md +9 -0
- package/projects/stego-docs/spine/concepts/CON-STAGE-GATE.md +10 -0
- package/projects/stego-docs/spine/concepts/CON-WORKSPACE.md +9 -0
- package/projects/stego-docs/spine/concepts/_category.md +6 -0
- package/projects/stego-docs/spine/configuration/CFG-ALLOWED-STATUSES.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-COMPILE-LEVELS.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-COMPILE-STRUCTURE.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-REQUIRED-METADATA.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-SPINE-CATEGORIES.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-STAGE-POLICIES.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-STEGO-CONFIG.md +9 -0
- package/projects/stego-docs/spine/configuration/CFG-STEGO-PROJECT.md +9 -0
- package/projects/stego-docs/spine/configuration/_category.md +6 -0
- package/projects/stego-docs/spine/integrations/INT-CSPELL.md +9 -0
- package/projects/stego-docs/spine/integrations/INT-MARKDOWNLINT.md +9 -0
- package/projects/stego-docs/spine/integrations/INT-PANDOC.md +9 -0
- package/projects/stego-docs/spine/integrations/INT-SAURUS-EXTENSION.md +9 -0
- package/projects/stego-docs/spine/integrations/INT-STEGO-EXTENSION.md +9 -0
- package/projects/stego-docs/spine/integrations/INT-VSCODE.md +9 -0
- package/projects/stego-docs/spine/integrations/_category.md +6 -0
- package/projects/stego-docs/spine/workflows/FLOW-BUILD-EXPORT.md +10 -0
- package/projects/stego-docs/spine/workflows/FLOW-DAILY-WRITING.md +10 -0
- package/projects/stego-docs/spine/workflows/FLOW-INIT-WORKSPACE.md +9 -0
- package/projects/stego-docs/spine/workflows/FLOW-NEW-PROJECT.md +10 -0
- package/projects/stego-docs/spine/workflows/FLOW-PROOF-RELEASE.md +10 -0
- package/projects/stego-docs/spine/workflows/FLOW-STAGE-PROMOTION.md +10 -0
- package/projects/stego-docs/spine/workflows/_category.md +6 -0
- package/projects/stego-docs/stego-project.json +1 -28
- package/projects/fiction-example/spine/characters.md +0 -35
- package/projects/fiction-example/spine/locations.md +0 -37
- package/projects/fiction-example/spine/sources.md +0 -31
- package/projects/stego-docs/spine/commands.md +0 -71
- package/projects/stego-docs/spine/concepts.md +0 -72
- package/projects/stego-docs/spine/configuration.md +0 -57
- package/projects/stego-docs/spine/integrations.md +0 -43
- package/projects/stego-docs/spine/workflows.md +0 -48
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Canon Raoul de Villiers
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Canon Raoul de Villiers
|
|
6
|
+
|
|
7
|
+
## Role
|
|
8
|
+
Cathedral canon and royal intermediary overseeing the inquiry
|
|
9
|
+
|
|
10
|
+
## Disposition
|
|
11
|
+
Pragmatic, literate, concerned with language fit for governance; judges arguments by their civic effects more than their truth
|
|
12
|
+
|
|
13
|
+
## Sources
|
|
14
|
+
Receives reports through institutional channels and favors accounts legible to ecclesiastical and civic authority
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
The institutional filter; commissions Matthaeus (CHAR-MATTHAEUS) and decides whether conclusions are published, softened, or suppressed
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Charnel precinct at the cemetery edge
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Charnel precinct at the cemetery edge
|
|
6
|
+
|
|
7
|
+
## Type
|
|
8
|
+
Overflow burial ground
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
Holy Innocents' Cemetery (https://en.wikipedia.org/wiki/Saints_Innocents%27_Cemetery)
|
|
12
|
+
|
|
13
|
+
## Conditions
|
|
14
|
+
Compressed ritual and civic exhaustion; the place where the dead arrive faster than rites can keep pace
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
Makes the demand for explanation urgent, not because explanation prevents death, but because it prevents a city from narrating its own collapse as pure noise
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: College chamber near the Rue Saint-Jacques
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# College chamber near the Rue Saint-Jacques
|
|
6
|
+
|
|
7
|
+
## Type
|
|
8
|
+
Study and disputation room
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
University of Paris (https://en.wikipedia.org/wiki/University_of_Paris); Rue Saint-Jacques (https://en.wikipedia.org/wiki/Rue_Saint-Jacques_(Paris))
|
|
12
|
+
|
|
13
|
+
## Conditions
|
|
14
|
+
Stone-walled, poorly lit, dominated by manuscripts and argument; where Matthaeus (CHAR-MATTHAEUS) and Etienne (CHAR-ETIENNE) assemble the memorandum
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
The construction site of the system; physically separate from the wards and quays where the plague is observed
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Hôtel-Dieu
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Hôtel-Dieu
|
|
6
|
+
|
|
7
|
+
## Type
|
|
8
|
+
Hospital ward near Notre-Dame
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
Hôtel-Dieu de Paris (https://en.wikipedia.org/wiki/H%C3%B4tel-Dieu_de_Paris)
|
|
12
|
+
|
|
13
|
+
## Conditions
|
|
14
|
+
Crowded, loud, and procedural; priests read offices while surgeons open buboes and Agnes (CHAR-AGNES) manages supplies and triage flow
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
Primary site of observation, where evidence is generated before it is abstracted into doctrine elsewhere
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Grain quay on the Seine
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Grain quay on the Seine
|
|
6
|
+
|
|
7
|
+
## Type
|
|
8
|
+
River unloading and distribution zone
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
Port de la Grève (https://en.wikipedia.org/wiki/Place_de_Gr%C3%A8ve)
|
|
12
|
+
|
|
13
|
+
## Conditions
|
|
14
|
+
Torn sackcloth, dense foot traffic, and constant commercial contact between upstream suppliers and city markets
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
The strongest material route in Agnes's observations (SRC-WARD-DATA), and the hardest case for conjunction-first framing (SRC-CONJUNCTION) to absorb without distortion
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: The Great Conjunction theory
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# The Great Conjunction theory
|
|
6
|
+
|
|
7
|
+
## Tradition
|
|
8
|
+
University astrology; often cited in faculty-level plague reasoning
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
Great Conjunction (https://en.wikipedia.org/wiki/Great_conjunction)
|
|
12
|
+
|
|
13
|
+
## Claim
|
|
14
|
+
The conjunction of Saturn, Jupiter, and Mars in Aquarius corrupted the atmosphere universally; local outbreaks are secondary effects of a celestial primary cause
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
Serves as the apex of Matthaeus's hierarchy (CHAR-MATTHAEUS) and as the politically safest explanation for Raoul (CHAR-RAOUL)
|
|
18
|
+
|
|
19
|
+
## Limitation
|
|
20
|
+
Its universal scope makes it difficult to generate specific local predictions
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Galenic humoral medicine
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Galenic humoral medicine
|
|
6
|
+
|
|
7
|
+
## Tradition
|
|
8
|
+
Greco-Arabic medical inheritance
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
Humorism (https://en.wikipedia.org/wiki/Humorism); Galen (https://en.wikipedia.org/wiki/Galen)
|
|
12
|
+
|
|
13
|
+
## Claim
|
|
14
|
+
Susceptibility depends on bodily complexion; treatment attempts to restore humoral balance through regimen, purgation, and environmental adjustment
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
Provides Matthaeus (CHAR-MATTHAEUS) a middle explanatory layer between universal celestial disposition and observed local spread
|
|
18
|
+
|
|
19
|
+
## Limitation
|
|
20
|
+
Struggles to account for synchronized neighborhood outbreaks regardless of individual constitution
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Agnes's ward observations
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Agnes's ward observations
|
|
6
|
+
|
|
7
|
+
## Tradition
|
|
8
|
+
Empirical record-keeping without institutional sponsorship
|
|
9
|
+
|
|
10
|
+
## Reference
|
|
11
|
+
Miasma theory (https://en.wikipedia.org/wiki/Miasma_theory) as the contemporary framework her observations press against
|
|
12
|
+
|
|
13
|
+
## Claim
|
|
14
|
+
Infection tracks grain traffic and commercial proximity; quay-connected districts (LOC-QUAY) sicken first, then adjacent streets, then broader quarters
|
|
15
|
+
|
|
16
|
+
## Function
|
|
17
|
+
Operational knowledge for Agnes (CHAR-AGNES); acknowledged by Matthaeus (CHAR-MATTHAEUS) but recast as a secondary distributing cause under celestial disposition
|
|
18
|
+
|
|
19
|
+
## Limitation
|
|
20
|
+
Accurate pattern recognition without an accepted formal theory, which weakens institutional uptake
|
|
@@ -20,22 +20,5 @@
|
|
|
20
20
|
"pageBreak": "between-groups"
|
|
21
21
|
}
|
|
22
22
|
]
|
|
23
|
-
}
|
|
24
|
-
"spineCategories": [
|
|
25
|
-
{
|
|
26
|
-
"key": "characters",
|
|
27
|
-
"prefix": "CHAR",
|
|
28
|
-
"notesFile": "characters.md"
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
"key": "locations",
|
|
32
|
-
"prefix": "LOC",
|
|
33
|
-
"notesFile": "locations.md"
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
"key": "sources",
|
|
37
|
-
"prefix": "SRC",
|
|
38
|
-
"notesFile": "sources.md"
|
|
39
|
-
}
|
|
40
|
-
]
|
|
23
|
+
}
|
|
41
24
|
}
|
|
@@ -51,8 +51,8 @@ Grouping metadata can be repeated at boundaries only, because Stego inherits mis
|
|
|
51
51
|
|
|
52
52
|
## Spine categories
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
Spine V2 infers categories from directory structure under `spine/`.
|
|
55
55
|
|
|
56
|
-
Each category
|
|
56
|
+
Each category lives at `spine/<category>/`, category metadata lives in `spine/<category>/_category.md`, and each entry is its own markdown file in that category directory tree.
|
|
57
57
|
|
|
58
|
-
This project uses
|
|
58
|
+
This project uses spine categories to model documentation entities such as commands, concepts, workflows, configuration topics, and integrations.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego build --project <project-id> [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego build --project <project-id> [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego build --project <project-id> [--root <path>]`
|
|
8
|
+
- Compile manuscript files into one generated markdown output.
|
|
9
|
+
- Related workflows: FLOW-BUILD-EXPORT, FLOW-DAILY-WRITING.
|
|
10
|
+
- Related concepts: CON-MANUSCRIPT, CON-DIST, CON-COMPILE-STRUCTURE.
|
|
11
|
+
- Related configuration: CFG-COMPILE-STRUCTURE, CFG-COMPILE-LEVELS.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]`
|
|
8
|
+
- Run stage-aware checks for a requested editorial stage.
|
|
9
|
+
- Related workflows: FLOW-STAGE-PROMOTION, FLOW-PROOF-RELEASE.
|
|
10
|
+
- Related concepts: CON-STAGE-GATE, CON-METADATA.
|
|
11
|
+
- Related configuration: CFG-STAGE-POLICIES, CFG-ALLOWED-STATUSES.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]`
|
|
8
|
+
- Export compiled output to target formats.
|
|
9
|
+
- Related workflows: FLOW-BUILD-EXPORT, FLOW-PROOF-RELEASE.
|
|
10
|
+
- Related concepts: CON-DIST.
|
|
11
|
+
- Related integrations: INT-PANDOC.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego init [--force]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego init [--force]
|
|
6
|
+
|
|
7
|
+
- `stego init [--force]`
|
|
8
|
+
- Initialize a Stego workspace in the current directory.
|
|
9
|
+
- Related workflows: FLOW-INIT-WORKSPACE.
|
|
10
|
+
- Related concepts: CON-WORKSPACE, CON-PROJECT.
|
|
11
|
+
- Related integrations: INT-VSCODE.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego list-projects [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego list-projects [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego list-projects [--root <path>]`
|
|
8
|
+
- List projects found in the current workspace.
|
|
9
|
+
- Related workflows: FLOW-INIT-WORKSPACE, FLOW-DAILY-WRITING.
|
|
10
|
+
- Related concepts: CON-WORKSPACE, CON-PROJECT.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego new-project --project <project-id> [--title <title>] [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego new-project --project <project-id> [--title <title>] [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego new-project --project <project-id> [--title <title>] [--root <path>]`
|
|
8
|
+
- Scaffold a new project under `projects/`.
|
|
9
|
+
- Related workflows: FLOW-NEW-PROJECT.
|
|
10
|
+
- Related concepts: CON-PROJECT, CON-MANUSCRIPT, CON-NOTES, CON-DIST.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]`
|
|
8
|
+
- Create a new manuscript file with an inferred numeric prefix and draft frontmatter.
|
|
9
|
+
- Related workflows: FLOW-DAILY-WRITING.
|
|
10
|
+
- Related concepts: CON-MANUSCRIPT, CON-METADATA.
|
|
11
|
+
- Related configuration: CFG-REQUIRED-METADATA.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]
|
|
6
|
+
|
|
7
|
+
- `stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]`
|
|
8
|
+
- Validate project configuration, manuscript structure, metadata, and references.
|
|
9
|
+
- Related workflows: FLOW-DAILY-WRITING, FLOW-STAGE-PROMOTION.
|
|
10
|
+
- Related concepts: CON-METADATA, CON-SPINE.
|
|
11
|
+
- Related configuration: CFG-REQUIRED-METADATA, CFG-SPINE-CATEGORIES.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Compile structure groups ordered files into larger sections during build.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Compile structure groups ordered files into larger sections during build.
|
|
6
|
+
|
|
7
|
+
- Compile structure groups ordered files into larger sections during build.
|
|
8
|
+
- Related commands: CMD-BUILD.
|
|
9
|
+
- Related configuration: CFG-COMPILE-STRUCTURE, CFG-COMPILE-LEVELS.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: `dist/` is generated output only and can be rebuilt from sources.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# `dist/` is generated output only and can be rebuilt from sources.
|
|
6
|
+
|
|
7
|
+
- `dist/` is generated output only and can be rebuilt from sources.
|
|
8
|
+
- Related commands: CMD-BUILD, CMD-EXPORT.
|
|
9
|
+
- Related workflows: FLOW-BUILD-EXPORT, FLOW-PROOF-RELEASE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: `manuscript/` contains canonical source writing files ordered by filename prefix.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# `manuscript/` contains canonical source writing files ordered by filename prefix.
|
|
6
|
+
|
|
7
|
+
- `manuscript/` contains canonical source writing files ordered by filename prefix.
|
|
8
|
+
- Related commands: CMD-VALIDATE, CMD-BUILD.
|
|
9
|
+
- Related configuration: CFG-REQUIRED-METADATA, CFG-COMPILE-STRUCTURE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Frontmatter metadata drives validation, stage checks, grouping, and continuity references.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Frontmatter metadata drives validation, stage checks, grouping, and continuity references.
|
|
6
|
+
|
|
7
|
+
- Frontmatter metadata drives validation, stage checks, grouping, and continuity references.
|
|
8
|
+
- Related commands: CMD-VALIDATE, CMD-CHECK-STAGE.
|
|
9
|
+
- Related configuration: CFG-REQUIRED-METADATA, CFG-ALLOWED-STATUSES.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: `notes/` contains supporting material that is not part of compiled manuscript output.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# `notes/` contains supporting material that is not part of compiled manuscript output.
|
|
6
|
+
|
|
7
|
+
- `notes/` contains supporting material that is not part of compiled manuscript output.
|
|
8
|
+
- Related commands: CMD-NEW-PROJECT.
|
|
9
|
+
- Related workflows: FLOW-DAILY-WRITING.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: A project is one writing unit inside `projects/<project-id>/` with its own `stego-project.json` and manuscript files in `/projects/<project-id>/manuscripts`.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# A project is one writing unit inside `projects/<project-id>/` with its own `stego-project.json` and manuscript files in `/projects/<project-id>/manuscripts`.
|
|
6
|
+
|
|
7
|
+
- A project is one writing unit inside `projects/<project-id>/` with its own `stego-project.json` and manuscript files in `/projects/<project-id>/manuscripts`.
|
|
8
|
+
- Related commands: CMD-NEW-PROJECT, CMD-VALIDATE, CMD-BUILD.
|
|
9
|
+
- Related workflows: FLOW-NEW-PROJECT, FLOW-DAILY-WRITING.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: A spine category is inferred from a directory under spine/.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# A spine category is inferred from a directory under spine/.
|
|
6
|
+
|
|
7
|
+
- A spine category is inferred from `spine/<category>/`.
|
|
8
|
+
- Category metadata lives in `spine/<category>/_category.md`.
|
|
9
|
+
- Entry files inside that directory define the category's canonical records.
|
|
10
|
+
- Related concepts: CON-SPINE, CON-METADATA.
|
|
11
|
+
- Related configuration: CFG-SPINE-CATEGORIES.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: `spine/` stores canonical entities used for continuity and navigation.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# `spine/` stores canonical entities used for continuity and navigation.
|
|
6
|
+
|
|
7
|
+
- `spine/` stores canonical entities used for continuity and navigation.
|
|
8
|
+
- Related configuration: CFG-SPINE-CATEGORIES.
|
|
9
|
+
- Related integrations: INT-STEGO-EXTENSION.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Stage gates apply stricter checks as work moves from drafting to release.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Stage gates apply stricter checks as work moves from drafting to release.
|
|
6
|
+
|
|
7
|
+
- Stage gates apply stricter checks as work moves from drafting to release.
|
|
8
|
+
- Related commands: CMD-CHECK-STAGE.
|
|
9
|
+
- Related workflows: FLOW-STAGE-PROMOTION, FLOW-PROOF-RELEASE.
|
|
10
|
+
- Related configuration: CFG-STAGE-POLICIES.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
|
|
6
|
+
|
|
7
|
+
- A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
|
|
8
|
+
- Related commands: CMD-INIT, CMD-LIST-PROJECTS.
|
|
9
|
+
- Related workflows: FLOW-INIT-WORKSPACE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Workspace-level list of allowed manuscript statuses.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Workspace-level list of allowed manuscript statuses.
|
|
6
|
+
|
|
7
|
+
- Workspace-level list of allowed manuscript statuses.
|
|
8
|
+
- Related concepts: CON-METADATA, CON-STAGE-GATE.
|
|
9
|
+
- Related commands: CMD-VALIDATE, CMD-CHECK-STAGE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options.
|
|
6
|
+
|
|
7
|
+
- The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options.
|
|
8
|
+
- Related configuration: CFG-COMPILE-STRUCTURE.
|
|
9
|
+
- Related concepts: CON-COMPILE-STRUCTURE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Build grouping configuration that defines structural levels and heading behavior.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Build grouping configuration that defines structural levels and heading behavior.
|
|
6
|
+
|
|
7
|
+
- Build grouping configuration that defines structural levels and heading behavior.
|
|
8
|
+
- Related concepts: CON-COMPILE-STRUCTURE.
|
|
9
|
+
- Related commands: CMD-BUILD.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Advisory list of frontmatter keys expected in manuscript files.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Advisory list of frontmatter keys expected in manuscript files.
|
|
6
|
+
|
|
7
|
+
- Advisory list of frontmatter keys expected in manuscript files.
|
|
8
|
+
- Related concepts: CON-METADATA.
|
|
9
|
+
- Related commands: CMD-VALIDATE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Spine V2 categories inferred from spine directory structure and per-entry files.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Spine V2 categories inferred from spine directory structure and per-entry files.
|
|
6
|
+
|
|
7
|
+
- Spine V2 categories are inferred from `spine/<category>/` directories.
|
|
8
|
+
- Category metadata is stored in `spine/<category>/_category.md`.
|
|
9
|
+
- Entry files under each category directory define canonical records.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Stage policy settings determine which checks are enforced at each stage.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Stage policy settings determine which checks are enforced at each stage.
|
|
6
|
+
|
|
7
|
+
- Stage policy settings determine which checks are enforced at each stage.
|
|
8
|
+
- Related concepts: CON-STAGE-GATE.
|
|
9
|
+
- Related commands: CMD-CHECK-STAGE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
|
|
6
|
+
|
|
7
|
+
- Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
|
|
8
|
+
- Related concepts: CON-WORKSPACE.
|
|
9
|
+
- Related commands: CMD-LIST-PROJECTS, CMD-CHECK-STAGE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories.
|
|
6
|
+
|
|
7
|
+
- Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories.
|
|
8
|
+
- Related concepts: CON-PROJECT, CON-METADATA, CON-SPINE.
|
|
9
|
+
- Related commands: CMD-VALIDATE, CMD-BUILD.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: CSpell supports spelling and terminology checks during later-stage quality passes.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# CSpell supports spelling and terminology checks during later-stage quality passes.
|
|
6
|
+
|
|
7
|
+
- CSpell supports spelling and terminology checks during later-stage quality passes.
|
|
8
|
+
- Related concepts: CON-STAGE-GATE.
|
|
9
|
+
- Related workflows: FLOW-PROOF-RELEASE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Markdownlint is used in stricter proofreading and release stages.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Markdownlint is used in stricter proofreading and release stages.
|
|
6
|
+
|
|
7
|
+
- Markdownlint is used in stricter proofreading and release stages.
|
|
8
|
+
- Related concepts: CON-STAGE-GATE.
|
|
9
|
+
- Related workflows: FLOW-PROOF-RELEASE.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Pandoc is used for optional export formats such as docx, pdf, and epub.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Pandoc is used for optional export formats such as docx, pdf, and epub.
|
|
6
|
+
|
|
7
|
+
- Pandoc is used for optional export formats such as docx, pdf, and epub.
|
|
8
|
+
- Related commands: CMD-EXPORT.
|
|
9
|
+
- Related workflows: FLOW-BUILD-EXPORT.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: The Saurus extension complements prose editing and research workflows in project folders.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# The Saurus extension complements prose editing and research workflows in project folders.
|
|
6
|
+
|
|
7
|
+
- The Saurus extension complements prose editing and research workflows in project folders.
|
|
8
|
+
- Related integrations: INT-VSCODE.
|
|
9
|
+
- Related workflows: FLOW-DAILY-WRITING.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation.
|
|
6
|
+
|
|
7
|
+
- The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation.
|
|
8
|
+
- Related concepts: CON-SPINE, CON-STAGE-GATE.
|
|
9
|
+
- Related workflows: FLOW-DAILY-WRITING, FLOW-STAGE-PROMOTION.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: VS Code is the primary editor environment for Stego projects.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# VS Code is the primary editor environment for Stego projects.
|
|
6
|
+
|
|
7
|
+
- VS Code is the primary editor environment for Stego projects.
|
|
8
|
+
- Related workflows: FLOW-INIT-WORKSPACE, FLOW-DAILY-WRITING.
|
|
9
|
+
- Related commands: CMD-INIT.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Build a compiled markdown manuscript and export distribution formats.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Build a compiled markdown manuscript and export distribution formats.
|
|
6
|
+
|
|
7
|
+
- Build a compiled markdown manuscript and export distribution formats.
|
|
8
|
+
- Related commands: CMD-BUILD, CMD-EXPORT.
|
|
9
|
+
- Related concepts: CON-DIST, CON-COMPILE-STRUCTURE.
|
|
10
|
+
- Related integrations: INT-PANDOC.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
label: Open one project, write in manuscript files, validate, build, and commit progress.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Open one project, write in manuscript files, validate, build, and commit progress.
|
|
6
|
+
|
|
7
|
+
- Open one project, write in manuscript files, validate, build, and commit progress.
|
|
8
|
+
- Related commands: CMD-VALIDATE, CMD-BUILD.
|
|
9
|
+
- Related concepts: CON-MANUSCRIPT, CON-METADATA, CON-DIST.
|
|
10
|
+
- Related integrations: INT-VSCODE.
|