kingmadoc 0.3.0.dev12__tar.gz → 0.3.0.dev14__tar.gz

{kingmadoc-0.3.0.dev12 → kingmadoc-0.3.0.dev14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: kingmadoc
-Version: 0.3.0.dev12
+Version: 0.3.0.dev14
 Summary: Feature docs for AI coding agents: a plan with C4 diagrams before the code, a verification doc after.
 Project-URL: Homepage, https://github.com/ATkingma/KingmaDoc
 Project-URL: Issues, https://github.com/ATkingma/KingmaDoc/issues

{kingmadoc-0.3.0.dev12 → kingmadoc-0.3.0.dev14}/skill/SKILL.md

@@ -225,7 +225,8 @@ check passed without running it.
 Write `<output_dir>/<slug>-verify.md` next to the plan in the
 [verify format](reference/formats.md#verify-doc-docsfeaturesslug-verifymd) (ask first if it exists). Set
 **Status** to `Matches plan`, `Deviations found`, or `Not verified` (when checks could
-not run). Show the user the path, the number of deviations, and any failing check.
+not run). Diagrams in the verify doc follow the same `diagrams_png` mode as the plan.
+Show the user the path, the number of deviations, and any failing check.
 
 ## Diagram rules
 

{kingmadoc-0.3.0.dev12 → kingmadoc-0.3.0.dev14}/skill/codex.md

@@ -225,7 +225,8 @@ check passed without running it.
 Write `<output_dir>/<slug>-verify.md` next to the plan in the
 [verify format](#verify-doc-docsfeaturesslug-verifymd) (ask first if it exists). Set
 **Status** to `Matches plan`, `Deviations found`, or `Not verified` (when checks could
-not run). Show the user the path, the number of deviations, and any failing check.
+not run). Diagrams in the verify doc follow the same `diagrams_png` mode as the plan.
+Show the user the path, the number of deviations, and any failing check.
 
 ## Diagram rules
 
@@ -251,6 +252,9 @@ not run). Show the user the path, the number of deviations, and any failing chec
   `System_Boundary` alias ends in `_boundary` and is never used in `Rel`.
 - **Escaping**: inside quoted labels write `"` as `#quot;`. In titles, leave quotes as
   they are and drop `#` and `;` (they end a C4 title). Put everything on one line.
+- **Colour**: the normal Mermaid theme. No `style`, `classDef` or `%%{init}%%` colours in
+  UML (class, sequence) diagrams; colour only to make one thing stand out, such as the
+  changed containers below.
 - **Short labels**: about 50 characters at most; split a long message in two.
 - **Sequence aliases**: never `x`, `X`, `o` or `O` (they clash with the `-x` and `-o`
   arrows); use abbreviations of two or more letters (`ct`, `svc`).
@@ -290,8 +294,16 @@ this line: _Disabled in `.featuredoc.yml` (`diagrams`)._
 `<output_dir>/img/<slug>-<diagram>.png`, linked with `![<title>](img/<slug>-<diagram>.png)`)
 or `off` (no image, only the Mermaid block).
 
+- **Mode comes only from `.featuredoc.yml`.** No file or no `diagrams_png` key → `embed`.
+  Never infer the mode from existing files (an `img/` folder, how an earlier doc did it).
+- **Check before you finish:** in `embed` mode every image line starts with
+  `![...](data:image/png;base64,`. A relative path such as `](img/` is an error: embed it and
+  delete the loose PNG.
+- Embed the PNG with a script (read file → base64 → replace the line), never by hand.
+
 1. Write each ` ```mermaid ` block to a temporary `.mmd` file outside the repo and run:
-   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -p <puppeteer.json>`
+   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -t default -p <puppeteer.json>`
+   (`-t default`: Mermaid's normal theme; newer versions otherwise colour every shape).
 2. Set `PUPPETEER_SKIP_DOWNLOAD=true`, and let `puppeteer.json` point at an installed
    browser, so no Chromium is downloaded:
    `{"executablePath": "C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe"}`

{kingmadoc-0.3.0.dev12 → kingmadoc-0.3.0.dev14}/skill/copilot.md

@@ -225,7 +225,8 @@ check passed without running it.
 Write `<output_dir>/<slug>-verify.md` next to the plan in the
 [verify format](#verify-doc-docsfeaturesslug-verifymd) (ask first if it exists). Set
 **Status** to `Matches plan`, `Deviations found`, or `Not verified` (when checks could
-not run). Show the user the path, the number of deviations, and any failing check.
+not run). Diagrams in the verify doc follow the same `diagrams_png` mode as the plan.
+Show the user the path, the number of deviations, and any failing check.
 
 ## Diagram rules
 
@@ -251,6 +252,9 @@ not run). Show the user the path, the number of deviations, and any failing chec
   `System_Boundary` alias ends in `_boundary` and is never used in `Rel`.
 - **Escaping**: inside quoted labels write `"` as `#quot;`. In titles, leave quotes as
   they are and drop `#` and `;` (they end a C4 title). Put everything on one line.
+- **Colour**: the normal Mermaid theme. No `style`, `classDef` or `%%{init}%%` colours in
+  UML (class, sequence) diagrams; colour only to make one thing stand out, such as the
+  changed containers below.
 - **Short labels**: about 50 characters at most; split a long message in two.
 - **Sequence aliases**: never `x`, `X`, `o` or `O` (they clash with the `-x` and `-o`
   arrows); use abbreviations of two or more letters (`ct`, `svc`).
@@ -290,8 +294,16 @@ this line: _Disabled in `.featuredoc.yml` (`diagrams`)._
 `<output_dir>/img/<slug>-<diagram>.png`, linked with `![<title>](img/<slug>-<diagram>.png)`)
 or `off` (no image, only the Mermaid block).
 
+- **Mode comes only from `.featuredoc.yml`.** No file or no `diagrams_png` key → `embed`.
+  Never infer the mode from existing files (an `img/` folder, how an earlier doc did it).
+- **Check before you finish:** in `embed` mode every image line starts with
+  `![...](data:image/png;base64,`. A relative path such as `](img/` is an error: embed it and
+  delete the loose PNG.
+- Embed the PNG with a script (read file → base64 → replace the line), never by hand.
+
 1. Write each ` ```mermaid ` block to a temporary `.mmd` file outside the repo and run:
-   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -p <puppeteer.json>`
+   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -t default -p <puppeteer.json>`
+   (`-t default`: Mermaid's normal theme; newer versions otherwise colour every shape).
 2. Set `PUPPETEER_SKIP_DOWNLOAD=true`, and let `puppeteer.json` point at an installed
    browser, so no Chromium is downloaded:
    `{"executablePath": "C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe"}`

{kingmadoc-0.3.0.dev12 → kingmadoc-0.3.0.dev14}/skill/cursor.md

@@ -226,7 +226,8 @@ check passed without running it.
 Write `<output_dir>/<slug>-verify.md` next to the plan in the
 [verify format](#verify-doc-docsfeaturesslug-verifymd) (ask first if it exists). Set
 **Status** to `Matches plan`, `Deviations found`, or `Not verified` (when checks could
-not run). Show the user the path, the number of deviations, and any failing check.
+not run). Diagrams in the verify doc follow the same `diagrams_png` mode as the plan.
+Show the user the path, the number of deviations, and any failing check.
 
 ## Diagram rules
 
@@ -252,6 +253,9 @@ not run). Show the user the path, the number of deviations, and any failing chec
   `System_Boundary` alias ends in `_boundary` and is never used in `Rel`.
 - **Escaping**: inside quoted labels write `"` as `#quot;`. In titles, leave quotes as
   they are and drop `#` and `;` (they end a C4 title). Put everything on one line.
+- **Colour**: the normal Mermaid theme. No `style`, `classDef` or `%%{init}%%` colours in
+  UML (class, sequence) diagrams; colour only to make one thing stand out, such as the
+  changed containers below.
 - **Short labels**: about 50 characters at most; split a long message in two.
 - **Sequence aliases**: never `x`, `X`, `o` or `O` (they clash with the `-x` and `-o`
   arrows); use abbreviations of two or more letters (`ct`, `svc`).
@@ -291,8 +295,16 @@ this line: _Disabled in `.featuredoc.yml` (`diagrams`)._
 `<output_dir>/img/<slug>-<diagram>.png`, linked with `![<title>](img/<slug>-<diagram>.png)`)
 or `off` (no image, only the Mermaid block).
 
+- **Mode comes only from `.featuredoc.yml`.** No file or no `diagrams_png` key → `embed`.
+  Never infer the mode from existing files (an `img/` folder, how an earlier doc did it).
+- **Check before you finish:** in `embed` mode every image line starts with
+  `![...](data:image/png;base64,`. A relative path such as `](img/` is an error: embed it and
+  delete the loose PNG.
+- Embed the PNG with a script (read file → base64 → replace the line), never by hand.
+
 1. Write each ` ```mermaid ` block to a temporary `.mmd` file outside the repo and run:
-   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -p <puppeteer.json>`
+   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -t default -p <puppeteer.json>`
+   (`-t default`: Mermaid's normal theme; newer versions otherwise colour every shape).
 2. Set `PUPPETEER_SKIP_DOWNLOAD=true`, and let `puppeteer.json` point at an installed
    browser, so no Chromium is downloaded:
    `{"executablePath": "C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe"}`

{kingmadoc-0.3.0.dev12 → kingmadoc-0.3.0.dev14}/skill/reference/diagram-rules.md

@@ -22,6 +22,9 @@
   `System_Boundary` alias ends in `_boundary` and is never used in `Rel`.
 - **Escaping**: inside quoted labels write `"` as `#quot;`. In titles, leave quotes as
   they are and drop `#` and `;` (they end a C4 title). Put everything on one line.
+- **Colour**: the normal Mermaid theme. No `style`, `classDef` or `%%{init}%%` colours in
+  UML (class, sequence) diagrams; colour only to make one thing stand out, such as the
+  changed containers below.
 - **Short labels**: about 50 characters at most; split a long message in two.
 - **Sequence aliases**: never `x`, `X`, `o` or `O` (they clash with the `-x` and `-o`
   arrows); use abbreviations of two or more letters (`ct`, `svc`).
@@ -61,8 +64,16 @@ this line: _Disabled in `.featuredoc.yml` (`diagrams`)._
 `<output_dir>/img/<slug>-<diagram>.png`, linked with `![<title>](img/<slug>-<diagram>.png)`)
 or `off` (no image, only the Mermaid block).
 
+- **Mode comes only from `.featuredoc.yml`.** No file or no `diagrams_png` key → `embed`.
+  Never infer the mode from existing files (an `img/` folder, how an earlier doc did it).
+- **Check before you finish:** in `embed` mode every image line starts with
+  `![...](data:image/png;base64,`. A relative path such as `](img/` is an error: embed it and
+  delete the loose PNG.
+- Embed the PNG with a script (read file → base64 → replace the line), never by hand.
+
 1. Write each ` ```mermaid ` block to a temporary `.mmd` file outside the repo and run:
-   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -p <puppeteer.json>`
+   `npx -y @mermaid-js/mermaid-cli -i <tmp>.mmd -o <tmp>.png -s 2 -b white -t default -p <puppeteer.json>`
+   (`-t default`: Mermaid's normal theme; newer versions otherwise colour every shape).
 2. Set `PUPPETEER_SKIP_DOWNLOAD=true`, and let `puppeteer.json` point at an installed
    browser, so no Chromium is downloaded:
    `{"executablePath": "C:/Program Files (x86)/Microsoft/Edge/Application/msedge.exe"}`