@ankhorage/paradox 0.1.5 → 0.1.7

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.7
+
+### Patch Changes
+
+- 8a9c0ab: Update DEVTOOLS
+
+## 0.1.6
+
+### Patch Changes
+
+- 8ba8f5c: Remove the hardcoded Path resolution section from generated README output so consumer documentation only contains analyzed package content.
+
 ## 0.1.5
 
 ### Patch Changes

package/README.md

@@ -3,7 +3,7 @@
 
 # @ankhorage/paradox
 
-![license: MIT](./paradox/badges/license.svg) ![npm: v0.1.4](./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.6](./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.
 
@@ -291,15 +291,6 @@ graph TD
 
 </details>
 
-## Path resolution
-
-- Config discovery: searches upward from `process.cwd()` for `paradox.config.ts/js/mjs/cjs` (required; no fallback).
-- Package root: defaults to the directory containing `paradox.config.*`; `package.root` (when relative) resolves relative to that directory.
-- Output directory: defaults to `paradox/`; `output.dir` (when relative) resolves relative to the resolved package root and must stay inside it.
-- Modes:
-  - `safe`: writes generated artifacts only under the output directory
-  - `write`: additionally updates `<packageRoot>/README.md`
-
 ## Public API
 
 ### Config

package/dist/render/renderers/markdown.js

@@ -38,7 +38,6 @@ function renderReadme(model, outputDir, badges, diagrams) {
     }
     renderGeneratedDocumentation(lines, outputDir, diagrams);
     renderArchitecturePreview(lines, diagrams);
-    renderPathResolution(lines);
     renderReadmeApi(lines, model);
     return `${lines.join('\n').trimEnd()}\n`;
 }
@@ -128,15 +127,6 @@ function renderArchitecturePreview(lines, diagrams) {
         lines.push('</details>', '');
     }
 }
-function renderPathResolution(lines) {
-    lines.push('## Path resolution', '');
-    lines.push('- Config discovery: searches upward from `process.cwd()` for `paradox.config.ts/js/mjs/cjs` (required; no fallback).');
-    lines.push('- Package root: defaults to the directory containing `paradox.config.*`; `package.root` (when relative) resolves relative to that directory.');
-    lines.push('- Output directory: defaults to `paradox/`; `output.dir` (when relative) resolves relative to the resolved package root and must stay inside it.');
-    lines.push('- Modes:');
-    lines.push('  - `safe`: writes generated artifacts only under the output directory');
-    lines.push('  - `write`: additionally updates `<packageRoot>/README.md`', '');
-}
 function renderReadmeApi(lines, model) {
     const groups = getReadmeGroups(model);
     if (groups.length === 0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/paradox",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Deterministic documentation generator for TypeScript packages.",
   "license": "MIT",
   "publishConfig": {
@@ -61,7 +61,7 @@
     "ts-morph": "^24.0.0"
   },
   "devDependencies": {
-    "@ankhorage/devtools": "^1.0.5",
+    "@ankhorage/devtools": "^1.0.6",
     "@changesets/cli": "^2.31.0",
     "@types/bun": "^1.3.13",
     "typescript": "^5.6.3"