stego-cli 0.3.4 → 0.4.1

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.
Files changed (76) hide show
  1. package/.vscode/extensions.json +7 -0
  2. package/README.md +45 -0
  3. package/dist/metadata/metadata-command.js +127 -0
  4. package/dist/metadata/metadata-domain.js +209 -0
  5. package/dist/spine/spine-command.js +129 -0
  6. package/dist/spine/spine-domain.js +274 -0
  7. package/dist/stego-cli.js +358 -187
  8. package/package.json +3 -2
  9. package/projects/fiction-example/spine/characters/CHAR-AGNES.md +17 -0
  10. package/projects/fiction-example/spine/characters/CHAR-ETIENNE.md +17 -0
  11. package/projects/fiction-example/spine/characters/CHAR-MATTHAEUS.md +17 -0
  12. package/projects/fiction-example/spine/characters/CHAR-RAOUL.md +17 -0
  13. package/projects/fiction-example/spine/characters/_category.md +6 -0
  14. package/projects/fiction-example/spine/locations/LOC-CHARNEL.md +17 -0
  15. package/projects/fiction-example/spine/locations/LOC-COLLEGE.md +17 -0
  16. package/projects/fiction-example/spine/locations/LOC-HOTELDIEU.md +17 -0
  17. package/projects/fiction-example/spine/locations/LOC-QUAY.md +17 -0
  18. package/projects/fiction-example/spine/locations/_category.md +6 -0
  19. package/projects/fiction-example/spine/sources/SRC-CONJUNCTION.md +20 -0
  20. package/projects/fiction-example/spine/sources/SRC-GALEN.md +20 -0
  21. package/projects/fiction-example/spine/sources/SRC-WARD-DATA.md +20 -0
  22. package/projects/fiction-example/spine/sources/_category.md +6 -0
  23. package/projects/fiction-example/stego-project.json +1 -18
  24. package/projects/stego-docs/manuscript/500-project-configuration.md +3 -3
  25. package/projects/stego-docs/spine/commands/CMD-BUILD.md +11 -0
  26. package/projects/stego-docs/spine/commands/CMD-CHECK-STAGE.md +11 -0
  27. package/projects/stego-docs/spine/commands/CMD-EXPORT.md +11 -0
  28. package/projects/stego-docs/spine/commands/CMD-INIT.md +11 -0
  29. package/projects/stego-docs/spine/commands/CMD-LIST-PROJECTS.md +10 -0
  30. package/projects/stego-docs/spine/commands/CMD-NEW-PROJECT.md +10 -0
  31. package/projects/stego-docs/spine/commands/CMD-NEW.md +11 -0
  32. package/projects/stego-docs/spine/commands/CMD-VALIDATE.md +11 -0
  33. package/projects/stego-docs/spine/commands/_category.md +6 -0
  34. package/projects/stego-docs/spine/concepts/CON-COMPILE-STRUCTURE.md +9 -0
  35. package/projects/stego-docs/spine/concepts/CON-DIST.md +9 -0
  36. package/projects/stego-docs/spine/concepts/CON-MANUSCRIPT.md +9 -0
  37. package/projects/stego-docs/spine/concepts/CON-METADATA.md +9 -0
  38. package/projects/stego-docs/spine/concepts/CON-NOTES.md +9 -0
  39. package/projects/stego-docs/spine/concepts/CON-PROJECT.md +9 -0
  40. package/projects/stego-docs/spine/concepts/CON-SPINE-CATEGORY.md +11 -0
  41. package/projects/stego-docs/spine/concepts/CON-SPINE.md +9 -0
  42. package/projects/stego-docs/spine/concepts/CON-STAGE-GATE.md +10 -0
  43. package/projects/stego-docs/spine/concepts/CON-WORKSPACE.md +9 -0
  44. package/projects/stego-docs/spine/concepts/_category.md +6 -0
  45. package/projects/stego-docs/spine/configuration/CFG-ALLOWED-STATUSES.md +9 -0
  46. package/projects/stego-docs/spine/configuration/CFG-COMPILE-LEVELS.md +9 -0
  47. package/projects/stego-docs/spine/configuration/CFG-COMPILE-STRUCTURE.md +9 -0
  48. package/projects/stego-docs/spine/configuration/CFG-REQUIRED-METADATA.md +9 -0
  49. package/projects/stego-docs/spine/configuration/CFG-SPINE-CATEGORIES.md +9 -0
  50. package/projects/stego-docs/spine/configuration/CFG-STAGE-POLICIES.md +9 -0
  51. package/projects/stego-docs/spine/configuration/CFG-STEGO-CONFIG.md +9 -0
  52. package/projects/stego-docs/spine/configuration/CFG-STEGO-PROJECT.md +9 -0
  53. package/projects/stego-docs/spine/configuration/_category.md +6 -0
  54. package/projects/stego-docs/spine/integrations/INT-CSPELL.md +9 -0
  55. package/projects/stego-docs/spine/integrations/INT-MARKDOWNLINT.md +9 -0
  56. package/projects/stego-docs/spine/integrations/INT-PANDOC.md +9 -0
  57. package/projects/stego-docs/spine/integrations/INT-SAURUS-EXTENSION.md +9 -0
  58. package/projects/stego-docs/spine/integrations/INT-STEGO-EXTENSION.md +9 -0
  59. package/projects/stego-docs/spine/integrations/INT-VSCODE.md +9 -0
  60. package/projects/stego-docs/spine/integrations/_category.md +6 -0
  61. package/projects/stego-docs/spine/workflows/FLOW-BUILD-EXPORT.md +10 -0
  62. package/projects/stego-docs/spine/workflows/FLOW-DAILY-WRITING.md +10 -0
  63. package/projects/stego-docs/spine/workflows/FLOW-INIT-WORKSPACE.md +9 -0
  64. package/projects/stego-docs/spine/workflows/FLOW-NEW-PROJECT.md +10 -0
  65. package/projects/stego-docs/spine/workflows/FLOW-PROOF-RELEASE.md +10 -0
  66. package/projects/stego-docs/spine/workflows/FLOW-STAGE-PROMOTION.md +10 -0
  67. package/projects/stego-docs/spine/workflows/_category.md +6 -0
  68. package/projects/stego-docs/stego-project.json +1 -28
  69. package/projects/fiction-example/spine/characters.md +0 -35
  70. package/projects/fiction-example/spine/locations.md +0 -37
  71. package/projects/fiction-example/spine/sources.md +0 -31
  72. package/projects/stego-docs/spine/commands.md +0 -71
  73. package/projects/stego-docs/spine/concepts.md +0 -72
  74. package/projects/stego-docs/spine/configuration.md +0 -57
  75. package/projects/stego-docs/spine/integrations.md +0 -43
  76. package/projects/stego-docs/spine/workflows.md +0 -48
@@ -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,6 @@
1
+ ---
2
+ label: Integrations
3
+ ---
4
+
5
+ # Integrations
6
+
@@ -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.
@@ -0,0 +1,9 @@
1
+ ---
2
+ label: Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects.
3
+ ---
4
+
5
+ # Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects.
6
+
7
+ - Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects.
8
+ - Related commands: CMD-INIT, CMD-LIST-PROJECTS.
9
+ - Related concepts: CON-WORKSPACE, CON-PROJECT.
@@ -0,0 +1,10 @@
1
+ ---
2
+ label: Create a new project, review generated folders, and configure project metadata rules.
3
+ ---
4
+
5
+ # Create a new project, review generated folders, and configure project metadata rules.
6
+
7
+ - Create a new project, review generated folders, and configure project metadata rules.
8
+ - Related commands: CMD-NEW-PROJECT, CMD-VALIDATE.
9
+ - Related concepts: CON-PROJECT, CON-MANUSCRIPT, CON-SPINE.
10
+ - Related configuration: CFG-STEGO-PROJECT.
@@ -0,0 +1,10 @@
1
+ ---
2
+ label: Run strict checks, build outputs, export artifacts, and archive release files.
3
+ ---
4
+
5
+ # Run strict checks, build outputs, export artifacts, and archive release files.
6
+
7
+ - Run strict checks, build outputs, export artifacts, and archive release files.
8
+ - Related commands: CMD-CHECK-STAGE, CMD-BUILD, CMD-EXPORT.
9
+ - Related concepts: CON-STAGE-GATE, CON-DIST.
10
+ - Related integrations: INT-MARKDOWNLINT, INT-CSPELL.
@@ -0,0 +1,10 @@
1
+ ---
2
+ label: Move files through statuses and verify readiness with stage checks.
3
+ ---
4
+
5
+ # Move files through statuses and verify readiness with stage checks.
6
+
7
+ - Move files through statuses and verify readiness with stage checks.
8
+ - Related commands: CMD-CHECK-STAGE, CMD-VALIDATE.
9
+ - Related concepts: CON-STAGE-GATE, CON-METADATA.
10
+ - Related configuration: CFG-STAGE-POLICIES, CFG-ALLOWED-STATUSES.
@@ -0,0 +1,6 @@
1
+ ---
2
+ label: Workflows
3
+ ---
4
+
5
+ # Workflows
6
+
@@ -19,32 +19,5 @@
19
19
  "pageBreak": "between-groups"
20
20
  }
21
21
  ]
22
- },
23
- "spineCategories": [
24
- {
25
- "key": "commands",
26
- "prefix": "CMD",
27
- "notesFile": "commands.md"
28
- },
29
- {
30
- "key": "concepts",
31
- "prefix": "CON",
32
- "notesFile": "concepts.md"
33
- },
34
- {
35
- "key": "workflows",
36
- "prefix": "FLOW",
37
- "notesFile": "workflows.md"
38
- },
39
- {
40
- "key": "configuration",
41
- "prefix": "CFG",
42
- "notesFile": "configuration.md"
43
- },
44
- {
45
- "key": "integrations",
46
- "prefix": "INT",
47
- "notesFile": "integrations.md"
48
- }
49
- ]
22
+ }
50
23
  }
@@ -1,35 +0,0 @@
1
- # Characters
2
-
3
- ## CHAR-MATTHAEUS
4
- label: Magister Matthaeus de Rota
5
-
6
- - Magister Matthaeus de Rota
7
- - Role: Scholar of medicine and astrology at the University of Paris
8
- - Disposition: Methodical, sincere, incapable of leaving an observation outside his system; treats coherence as a moral obligation
9
- - Sources: Works primarily from the conjunction theory (SRC-CONJUNCTION) and Galenic tradition (SRC-GALEN); consults a prohibited astrological quire privately for its method of reasoning from hidden correspondences
10
- - Arc: Builds a total explanation of the {{pestilence}} and dies at peace inside it; the question is whether his peace is understanding or its most sophisticated substitute
11
-
12
- ## CHAR-ETIENNE
13
- label: Etienne of Saint-Marcel
14
-
15
- - Etienne of Saint-Marcel
16
- - Role: Young cleric-scribe attached to Matthaeus (CHAR-MATTHAEUS)
17
- - Disposition: Careful, loyal, doctrinally cautious; sees everything his master does and says nothing about the parts that trouble him
18
- - Function: The story's witness; records the system without fully believing it, but also without offering an alternative
19
-
20
- ## CHAR-AGNES
21
- label: Agnes the apothecary
22
-
23
- - Agnes the apothecary
24
- - Role: Compounder and practical healer near the Petit Pont; supplies Hôtel-Dieu (LOC-HOTELDIEU)
25
- - Disposition: Empirical, blunt, uninterested in frameworks that don't predict which street sickens next
26
- - Sources: Her own ward observations (SRC-WARD-DATA); she has no name for her method, which is part of its strength and its institutional weakness
27
- - Function: The counterweight; asks whether a system that can absorb any evidence without changing is a system or a habit
28
-
29
- ## CHAR-RAOUL
30
- label: Canon Raoul de Villiers
31
-
32
- - Canon Raoul de Villiers
33
- - Role: Cathedral canon and royal intermediary overseeing the inquiry
34
- - Disposition: Pragmatic, literate, concerned with language fit for governance; judges arguments by their civic effects, not their truth
35
- - Relationship: Commissioned Matthaeus (CHAR-MATTHAEUS) and will approve or suppress his conclusions; represents the institution's need for a single authorized account
@@ -1,37 +0,0 @@
1
- # Locations
2
-
3
- ## LOC-COLLEGE
4
- label: College chamber near the Rue Saint-Jacques
5
-
6
- - College chamber near the Rue Saint-Jacques
7
- - Study and disputation room
8
- - Reference: [University of Paris](https://en.wikipedia.org/wiki/University_of_Paris), [Rue Saint-Jacques](https://en.wikipedia.org/wiki/Rue_Saint-Jacques_(Paris))
9
- - Stone-walled, poorly lit, dominated by a long table covered in manuscripts; the room where Matthaeus (CHAR-MATTHAEUS) and Etienne (CHAR-ETIENNE) compile the memorandum
10
- - Significance: The space where the system is built; physically separated from the wards and streets where the plague actually operates
11
-
12
- ## LOC-HOTELDIEU
13
- label: "Hôtel-Dieu"
14
-
15
- - Hôtel-Dieu
16
- - Hospital ward near Notre-Dame
17
- - Reference: [Hôtel-Dieu de Paris](https://en.wikipedia.org/wiki/H%C3%B4tel-Dieu_de_Paris)
18
- - Crowded, loud, smelling of vinegar and linen; priests read offices while surgeons open buboes; Agnes (CHAR-AGNES) manages the supply lines
19
- - Significance: Where data is collected; the distance between this room and the college chamber is the distance between observation and explanation
20
-
21
- ## LOC-QUAY
22
- label: Grain quay on the Seine
23
-
24
- - Grain quay on the Seine
25
- - River unloading zone
26
- - Reference: [Port de la Grève](https://en.wikipedia.org/wiki/Place_de_Gr%C3%A8ve) (medieval commercial riverfront)
27
- - Torn sackcloth, heavy foot traffic, commercial contact between upstream suppliers and the city's markets
28
- - Significance: Agnes's observations (SRC-WARD-DATA) trace infection along this route; it is the strongest evidence for material transmission and the hardest for the celestial framework (SRC-CONJUNCTION) to accommodate
29
-
30
- ## LOC-CHARNEL
31
- label: Charnel precinct at the cemetery edge
32
-
33
- - Charnel precinct at the cemetery edge
34
- - Overflow burial ground
35
- - Reference: [Holy Innocents' Cemetery](https://en.wikipedia.org/wiki/Saints_Innocents%27_Cemetery)
36
- - Where the dead go when the dead outnumber the rites; compressed ritual, civic exhaustion
37
- - Significance: The place that makes the need for an explanation urgent — not because understanding will stop the dying, but because the alternative is dying without a frame
@@ -1,31 +0,0 @@
1
- # Sources
2
-
3
- ## SRC-CONJUNCTION
4
- label: The Great Conjunction theory
5
-
6
- - The Great Conjunction theory
7
- - Tradition: University astrology ([Paris faculty opinion of 1348](https://en.wikipedia.org/wiki/Black_Death#Medical_knowledge))
8
- - Reference: [Great Conjunction](https://en.wikipedia.org/wiki/Great_conjunction)
9
- - Claim: The conjunction of Saturn, Jupiter, and Mars in Aquarius corrupted the atmosphere universally; local outbreaks are secondary effects of a celestial primary cause
10
- - Used by: Matthaeus (CHAR-MATTHAEUS) as the apex of his causal hierarchy; Raoul (CHAR-RAOUL) as the politically safest framing
11
- - Limitation: Explains everything at once, which means it predicts nothing in particular
12
-
13
- ## SRC-GALEN
14
- label: Galenic humoral medicine
15
-
16
- - Galenic humoral medicine
17
- - Tradition: Greco-Arabic medical inheritance
18
- - Reference: [Humorism](https://en.wikipedia.org/wiki/Humorism), [Galen](https://en.wikipedia.org/wiki/Galen)
19
- - Claim: Individual susceptibility depends on bodily complexion (balance of humors); treatment involves restoring balance through diet, purgation, and environment
20
- - Used by: Matthaeus (CHAR-MATTHAEUS) as the middle layer of his framework — celestial disposition selects who is vulnerable, humoral constitution determines who actually sickens
21
- - Limitation: Cannot explain why entire neighborhoods fall at once regardless of individual constitution
22
-
23
- ## SRC-WARD-DATA
24
- label: "Agnes's ward observations"
25
-
26
- - Agnes's ward observations
27
- - Tradition: None; empirical record-keeping without institutional backing
28
- - Reference: [Miasma theory](https://en.wikipedia.org/wiki/Miasma_theory) (the contemporary framework Agnes's data implicitly challenges)
29
- - Claim: Infection follows grain traffic and commercial contact; neighborhoods tied to the quay (LOC-QUAY) sicken first, then adjacent streets, then the rest
30
- - Used by: Agnes (CHAR-AGNES) as practical knowledge; Matthaeus (CHAR-MATTHAEUS) acknowledges the pattern but classifies it as a secondary distributing cause, subordinate to celestial disposition
31
- - Limitation: No theoretical framework to explain why the pattern holds; accurate but institutionally weightless
@@ -1,71 +0,0 @@
1
- # Commands
2
-
3
- ## CMD-INIT
4
- label: stego init [--force]
5
-
6
- - `stego init [--force]`
7
- - Initialize a Stego workspace in the current directory.
8
- - Related workflows: FLOW-INIT-WORKSPACE.
9
- - Related concepts: CON-WORKSPACE, CON-PROJECT.
10
- - Related integrations: INT-VSCODE.
11
-
12
- ## CMD-LIST-PROJECTS
13
- label: stego list-projects [--root <path>]
14
-
15
- - `stego list-projects [--root <path>]`
16
- - List projects found in the current workspace.
17
- - Related workflows: FLOW-INIT-WORKSPACE, FLOW-DAILY-WRITING.
18
- - Related concepts: CON-WORKSPACE, CON-PROJECT.
19
-
20
- ## CMD-NEW-PROJECT
21
- label: stego new-project --project <project-id> [--title <title>] [--root <path>]
22
-
23
- - `stego new-project --project <project-id> [--title <title>] [--root <path>]`
24
- - Scaffold a new project under `projects/`.
25
- - Related workflows: FLOW-NEW-PROJECT.
26
- - Related concepts: CON-PROJECT, CON-MANUSCRIPT, CON-NOTES, CON-DIST.
27
-
28
- ## CMD-NEW
29
- label: stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]
30
-
31
- - `stego new --project <project-id> [--i <prefix>|-i <prefix>] [--filename <name>] [--root <path>]`
32
- - Create a new manuscript file with an inferred numeric prefix and draft frontmatter.
33
- - Related workflows: FLOW-DAILY-WRITING.
34
- - Related concepts: CON-MANUSCRIPT, CON-METADATA.
35
- - Related configuration: CFG-REQUIRED-METADATA.
36
-
37
- ## CMD-VALIDATE
38
- label: stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]
39
-
40
- - `stego validate --project <project-id> [--file <project-relative-manuscript-path>] [--root <path>]`
41
- - Validate project configuration, manuscript structure, metadata, and references.
42
- - Related workflows: FLOW-DAILY-WRITING, FLOW-STAGE-PROMOTION.
43
- - Related concepts: CON-METADATA, CON-SPINE.
44
- - Related configuration: CFG-REQUIRED-METADATA, CFG-SPINE-CATEGORIES.
45
-
46
- ## CMD-BUILD
47
- label: stego build --project <project-id> [--root <path>]
48
-
49
- - `stego build --project <project-id> [--root <path>]`
50
- - Compile manuscript files into one generated markdown output.
51
- - Related workflows: FLOW-BUILD-EXPORT, FLOW-DAILY-WRITING.
52
- - Related concepts: CON-MANUSCRIPT, CON-DIST, CON-COMPILE-STRUCTURE.
53
- - Related configuration: CFG-COMPILE-STRUCTURE, CFG-COMPILE-LEVELS.
54
-
55
- ## CMD-CHECK-STAGE
56
- label: stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]
57
-
58
- - `stego check-stage --project <project-id> --stage <draft|revise|line-edit|proof|final> [--file <project-relative-manuscript-path>] [--root <path>]`
59
- - Run stage-aware checks for a requested editorial stage.
60
- - Related workflows: FLOW-STAGE-PROMOTION, FLOW-PROOF-RELEASE.
61
- - Related concepts: CON-STAGE-GATE, CON-METADATA.
62
- - Related configuration: CFG-STAGE-POLICIES, CFG-ALLOWED-STATUSES.
63
-
64
- ## CMD-EXPORT
65
- label: stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]
66
-
67
- - `stego export --project <project-id> --format <md|docx|pdf|epub> [--output <path>] [--root <path>]`
68
- - Export compiled output to target formats.
69
- - Related workflows: FLOW-BUILD-EXPORT, FLOW-PROOF-RELEASE.
70
- - Related concepts: CON-DIST.
71
- - Related integrations: INT-PANDOC.
@@ -1,72 +0,0 @@
1
- # Concepts
2
-
3
- ## CON-WORKSPACE
4
- label: A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
5
-
6
- - A Stego workspace is the root directory containing `stego.config.json` and `projects/`.
7
- - Related commands: CMD-INIT, CMD-LIST-PROJECTS.
8
- - Related workflows: FLOW-INIT-WORKSPACE.
9
-
10
- ## CON-PROJECT
11
- 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`.
12
-
13
- - A project is one writing unit inside `projects/<project-id>/` with its own `stego-project.json` and manuscript files in `/projects/<project-id>/manuscripts`.
14
- - Related commands: CMD-NEW-PROJECT, CMD-VALIDATE, CMD-BUILD.
15
- - Related workflows: FLOW-NEW-PROJECT, FLOW-DAILY-WRITING.
16
-
17
- ## CON-MANUSCRIPT
18
- label: `manuscript/` contains canonical source writing files ordered by filename prefix.
19
-
20
- - `manuscript/` contains canonical source writing files ordered by filename prefix.
21
- - Related commands: CMD-VALIDATE, CMD-BUILD.
22
- - Related configuration: CFG-REQUIRED-METADATA, CFG-COMPILE-STRUCTURE.
23
-
24
- ## CON-SPINE
25
- label: `spine/` stores canonical entities used for continuity and navigation.
26
-
27
- - `spine/` stores canonical entities used for continuity and navigation.
28
- - Related configuration: CFG-SPINE-CATEGORIES.
29
- - Related integrations: INT-STEGO-EXTENSION.
30
-
31
- ## CON-NOTES
32
- label: `notes/` contains supporting material that is not part of compiled manuscript output.
33
-
34
- - `notes/` contains supporting material that is not part of compiled manuscript output.
35
- - Related commands: CMD-NEW-PROJECT.
36
- - Related workflows: FLOW-DAILY-WRITING.
37
-
38
- ## CON-DIST
39
- label: `dist/` is generated output only and can be rebuilt from sources.
40
-
41
- - `dist/` is generated output only and can be rebuilt from sources.
42
- - Related commands: CMD-BUILD, CMD-EXPORT.
43
- - Related workflows: FLOW-BUILD-EXPORT, FLOW-PROOF-RELEASE.
44
-
45
- ## CON-METADATA
46
- label: "Frontmatter metadata drives validation, stage checks, grouping, and continuity references."
47
-
48
- - Frontmatter metadata drives validation, stage checks, grouping, and continuity references.
49
- - Related commands: CMD-VALIDATE, CMD-CHECK-STAGE.
50
- - Related configuration: CFG-REQUIRED-METADATA, CFG-ALLOWED-STATUSES.
51
-
52
- ## CON-STAGE-GATE
53
- label: Stage gates apply stricter checks as work moves from drafting to release.
54
-
55
- - Stage gates apply stricter checks as work moves from drafting to release.
56
- - Related commands: CMD-CHECK-STAGE.
57
- - Related workflows: FLOW-STAGE-PROMOTION, FLOW-PROOF-RELEASE.
58
- - Related configuration: CFG-STAGE-POLICIES.
59
-
60
- ## CON-COMPILE-STRUCTURE
61
- label: Compile structure groups ordered files into larger sections during build.
62
-
63
- - Compile structure groups ordered files into larger sections during build.
64
- - Related commands: CMD-BUILD.
65
- - Related configuration: CFG-COMPILE-STRUCTURE, CFG-COMPILE-LEVELS.
66
-
67
- ## CON-SPINE-CATEGORY
68
- label: "A spine category defines a metadata key, ID prefix, and canonical notes file."
69
-
70
- - A spine category defines a metadata key, ID prefix, and canonical notes file.
71
- - Related concepts: CON-SPINE, CON-METADATA.
72
- - Related configuration: CFG-SPINE-CATEGORIES.
@@ -1,57 +0,0 @@
1
- # Configuration
2
-
3
- ## CFG-STEGO-CONFIG
4
- label: Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
5
-
6
- - Workspace-level configuration in `stego.config.json` defines shared directories and stage policies.
7
- - Related concepts: CON-WORKSPACE.
8
- - Related commands: CMD-LIST-PROJECTS, CMD-CHECK-STAGE.
9
-
10
- ## CFG-STEGO-PROJECT
11
- label: "Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories."
12
-
13
- - Project-level configuration in `stego-project.json` defines metadata rules, grouping, and spine categories.
14
- - Related concepts: CON-PROJECT, CON-METADATA, CON-SPINE.
15
- - Related commands: CMD-VALIDATE, CMD-BUILD.
16
-
17
- ## CFG-REQUIRED-METADATA
18
- label: Advisory list of frontmatter keys expected in manuscript files.
19
-
20
- - Advisory list of frontmatter keys expected in manuscript files.
21
- - Related concepts: CON-METADATA.
22
- - Related commands: CMD-VALIDATE.
23
-
24
- ## CFG-COMPILE-STRUCTURE
25
- label: Build grouping configuration that defines structural levels and heading behavior.
26
-
27
- - Build grouping configuration that defines structural levels and heading behavior.
28
- - Related concepts: CON-COMPILE-STRUCTURE.
29
- - Related commands: CMD-BUILD.
30
-
31
- ## CFG-COMPILE-LEVELS
32
- label: "The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options."
33
-
34
- - The ordered `levels` array inside compile structure, with keys, labels, title keys, and page break options.
35
- - Related configuration: CFG-COMPILE-STRUCTURE.
36
- - Related concepts: CON-COMPILE-STRUCTURE.
37
-
38
- ## CFG-SPINE-CATEGORIES
39
- label: Per-project category definitions mapping metadata keys to ID prefixes and spine files.
40
-
41
- - Per-project category definitions mapping metadata keys to ID prefixes and spine files.
42
- - Related concepts: CON-SPINE, CON-SPINE-CATEGORY.
43
- - Related commands: CMD-VALIDATE.
44
-
45
- ## CFG-STAGE-POLICIES
46
- label: Stage policy settings determine which checks are enforced at each stage.
47
-
48
- - Stage policy settings determine which checks are enforced at each stage.
49
- - Related concepts: CON-STAGE-GATE.
50
- - Related commands: CMD-CHECK-STAGE.
51
-
52
- ## CFG-ALLOWED-STATUSES
53
- label: Workspace-level list of allowed manuscript statuses.
54
-
55
- - Workspace-level list of allowed manuscript statuses.
56
- - Related concepts: CON-METADATA, CON-STAGE-GATE.
57
- - Related commands: CMD-VALIDATE, CMD-CHECK-STAGE.
@@ -1,43 +0,0 @@
1
- # Integrations
2
-
3
- ## INT-VSCODE
4
- label: VS Code is the primary editor environment for Stego projects.
5
-
6
- - VS Code is the primary editor environment for Stego projects.
7
- - Related workflows: FLOW-INIT-WORKSPACE, FLOW-DAILY-WRITING.
8
- - Related commands: CMD-INIT.
9
-
10
- ## INT-STEGO-EXTENSION
11
- label: "The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation."
12
-
13
- - The Stego VS Code extension is the official UI for Stego projects, including status controls, checks, and Spine Browser navigation.
14
- - Related concepts: CON-SPINE, CON-STAGE-GATE.
15
- - Related workflows: FLOW-DAILY-WRITING, FLOW-STAGE-PROMOTION.
16
-
17
- ## INT-SAURUS-EXTENSION
18
- label: The Saurus extension complements prose editing and research workflows in project folders.
19
-
20
- - The Saurus extension complements prose editing and research workflows in project folders.
21
- - Related integrations: INT-VSCODE.
22
- - Related workflows: FLOW-DAILY-WRITING.
23
-
24
- ## INT-PANDOC
25
- label: "Pandoc is used for optional export formats such as docx, pdf, and epub."
26
-
27
- - Pandoc is used for optional export formats such as docx, pdf, and epub.
28
- - Related commands: CMD-EXPORT.
29
- - Related workflows: FLOW-BUILD-EXPORT.
30
-
31
- ## INT-MARKDOWNLINT
32
- label: Markdownlint is used in stricter proofreading and release stages.
33
-
34
- - Markdownlint is used in stricter proofreading and release stages.
35
- - Related concepts: CON-STAGE-GATE.
36
- - Related workflows: FLOW-PROOF-RELEASE.
37
-
38
- ## INT-CSPELL
39
- label: CSpell supports spelling and terminology checks during later-stage quality passes.
40
-
41
- - CSpell supports spelling and terminology checks during later-stage quality passes.
42
- - Related concepts: CON-STAGE-GATE.
43
- - Related workflows: FLOW-PROOF-RELEASE.
@@ -1,48 +0,0 @@
1
- # Workflows
2
-
3
- ## FLOW-INIT-WORKSPACE
4
- label: "Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects."
5
-
6
- - Install the CLI, initialize a workspace, install local dev tools, and inspect scaffolded projects.
7
- - Related commands: CMD-INIT, CMD-LIST-PROJECTS.
8
- - Related concepts: CON-WORKSPACE, CON-PROJECT.
9
-
10
- ## FLOW-DAILY-WRITING
11
- label: "Open one project, write in manuscript files, validate, build, and commit progress."
12
-
13
- - Open one project, write in manuscript files, validate, build, and commit progress.
14
- - Related commands: CMD-VALIDATE, CMD-BUILD.
15
- - Related concepts: CON-MANUSCRIPT, CON-METADATA, CON-DIST.
16
- - Related integrations: INT-VSCODE.
17
-
18
- ## FLOW-NEW-PROJECT
19
- label: "Create a new project, review generated folders, and configure project metadata rules."
20
-
21
- - Create a new project, review generated folders, and configure project metadata rules.
22
- - Related commands: CMD-NEW-PROJECT, CMD-VALIDATE.
23
- - Related concepts: CON-PROJECT, CON-MANUSCRIPT, CON-SPINE.
24
- - Related configuration: CFG-STEGO-PROJECT.
25
-
26
- ## FLOW-STAGE-PROMOTION
27
- label: Move files through statuses and verify readiness with stage checks.
28
-
29
- - Move files through statuses and verify readiness with stage checks.
30
- - Related commands: CMD-CHECK-STAGE, CMD-VALIDATE.
31
- - Related concepts: CON-STAGE-GATE, CON-METADATA.
32
- - Related configuration: CFG-STAGE-POLICIES, CFG-ALLOWED-STATUSES.
33
-
34
- ## FLOW-BUILD-EXPORT
35
- label: Build a compiled markdown manuscript and export distribution formats.
36
-
37
- - Build a compiled markdown manuscript and export distribution formats.
38
- - Related commands: CMD-BUILD, CMD-EXPORT.
39
- - Related concepts: CON-DIST, CON-COMPILE-STRUCTURE.
40
- - Related integrations: INT-PANDOC.
41
-
42
- ## FLOW-PROOF-RELEASE
43
- label: "Run strict checks, build outputs, export artifacts, and archive release files."
44
-
45
- - Run strict checks, build outputs, export artifacts, and archive release files.
46
- - Related commands: CMD-CHECK-STAGE, CMD-BUILD, CMD-EXPORT.
47
- - Related concepts: CON-STAGE-GATE, CON-DIST.
48
- - Related integrations: INT-MARKDOWNLINT, INT-CSPELL.