@ankhorage/paradox 0.1.2 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.1.3
+
+### Patch Changes
+
+- 919d454: Render README CLI entries as per-command accordions and show sequence diagrams directly inside the expanded command section.
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -3,7 +3,7 @@
 
 # @ankhorage/paradox
 
-![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.1](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
+![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.2](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
 
 Deterministic documentation generator for TypeScript packages.
 
@@ -15,7 +15,8 @@ bunx @ankhorage/paradox
 
 ## CLI
 
-### paradox
+<details>
+<summary>paradox</summary>
 
 Runs the Paradox CLI.
 
@@ -27,9 +28,6 @@ and writes them to the configured output directory.
 bunx @ankhorage/paradox
 ```
 
-<details>
-<summary>paradox sequence</summary>
-
 Diagram: [paradox sequence](./paradox/diagrams/sequences/paradox.mmd)
 
 ```mermaid

package/dist/render/renderers/markdown.js

@@ -49,7 +49,8 @@ function renderCliScenarios(lines, model, outputDir, diagrams) {
         return;
     lines.push('## CLI', '');
     for (const scenario of scenarios) {
-        lines.push(`### ${scenario.name}`, '');
+        lines.push('<details>');
+        lines.push(`<summary>${scenario.name}</summary>`, '');
         if (scenario.description !== null) {
             lines.push(scenario.description, '');
         }
@@ -61,14 +62,12 @@ function renderCliScenarios(lines, model, outputDir, diagrams) {
         }
         const diagram = findScenarioDiagram(diagrams, scenario);
         if (diagram !== undefined) {
-            lines.push('<details>');
-            lines.push(`<summary>${scenario.name} sequence</summary>`, '');
             lines.push(`Diagram: [${diagram.title}](./${outputDir}/${diagram.path})`, '');
             lines.push('```mermaid');
             lines.push(diagram.content.trimEnd());
             lines.push('```', '');
-            lines.push('</details>', '');
         }
+        lines.push('</details>', '');
     }
 }
 function findScenarioDiagram(diagrams, scenario) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {