iobroker.autodoc 0.9.37 → 0.9.38

package/README.md

@@ -4,11 +4,11 @@
 
 Automatically generates structured documentation (HTML, Markdown, JSON) for your ioBroker installation — on demand, on a schedule, or when the system changes.
 
-**Version:** 0.9.37
+**Version:** 0.9.38
 
 | | |
 | --- | --- |
-| **Install** | [ioBroker Admin](https://www.iobroker.net/#en/documentation) — [npm](https://www.npmjs.com/package/iobroker.autodoc) package **`iobroker.autodoc`**, or install from this **Git** repository (URL / clone). Default adapter lists still need the package in [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories) (see [TODO — release](TODO.md#release-veroeffentlichung)). |
+| **Install** | [ioBroker Admin](https://www.iobroker.net/#en/documentation) — [npm](https://www.npmjs.com/package/iobroker.autodoc) package **`iobroker.autodoc`** (current **0.9.38**), **default adapter list** via [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories) (**latest**), or install from this **Git** repository (URL / clone). See [TODO — release](TODO.md#release-veroeffentlichung) for maintainer notes. |
 | **Repository** | [github.com/crunchip77/ioBroker.autodoc](https://github.com/crunchip77/ioBroker.autodoc) |
 | **Issues** | [GitHub Issues](https://github.com/crunchip77/ioBroker.autodoc/issues) |
 
@@ -89,12 +89,18 @@ For **roadmap and planning**: [`TODO.md`](TODO.md) (open work at the top, full c
 
 ### **WORK IN PROGRESS**
 
-- **Release prep:** Draft user-facing bullets here before **`npm run release`** (`CONTRIBUTING.md`). Open work: **[`TODO.md`](TODO.md)** · **[`PLAN.md`](PLAN.md)** · optional **PR** [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories) when ready.
+- **Release prep:** Draft user-facing bullets here before **`npm run release`** (`CONTRIBUTING.md`). **Standard list:** nach neuen npm-Versionen ggf. **ioBroker.repositories** mitziehen — **[`TODO.md` § 1.1](TODO.md#release-veroeffentlichung)** · **[`PLAN.md`](PLAN.md)**.
+
+### 0.9.38 (2026-05-12)
+
+- **Advanced — storage default:** **`documentationStatesMode`** default for **new** instances is now **`metadata`** (full HTML/Markdown/JSON in **`/files/`** only; `documentation.*` states are placeholders). Lowers object-database load for typical installs (e.g. Redis). **Existing** instances keep their saved value until you change **Dokumentation in States** in Admin. Scripts that relied on full text in states should use **`/files/`** paths or download actions (`common.news` + Admin help).
+- **Rationale:** With the adapter in **ioBroker.repositories** **latest**, new installations should avoid silently growing the **full**-mode footprint for everyone.
 
 ### 0.9.37 (2026-05-10)
 
 - **Tooling:** `runPdfExport` initializes the PDF digest map with a typed empty collection so **`npm run check`** (TypeScript) passes; no change to PDF export behavior.
 - **Docs:** Adapter-neutral **[`docs/iobroker-adapter-references.md`](docs/iobroker-adapter-references.md)** linked from **`TODO.md`**, **`CONTRIBUTING.md`**, and the Cursor project rule; **`PLAN.md`** phase **5.x.1** aligned with **`TODO.md`** (MVP complete).
+- **Distribution (follow-up):** **ioBroker.repositories** — **`autodoc`** in **latest**; damit im Admin neben **npm** und Git‑URL in der **Standard-Adapterliste** (siehe [TODO § 1.1](TODO.md#release-veroeffentlichung)).
 
 ### 0.9.36 (2026-05-09)
 
@@ -103,7 +109,7 @@ For **roadmap and planning**: [`TODO.md`](TODO.md) (open work at the top, full c
 ### 0.9.35 (2026-05-08)
 
 - **npm:** publish **`iobroker.autodoc`** on the public registry so hosts can `npm install` the adapter tarball without cloning.
-- **README:** install table reflects **npm** plus Git; default-list installs still depend on **ioBroker.repositories** (unchanged process).
+- **README:** install table reflects **npm** plus Git; default-list installs still depended on **ioBroker.repositories** (unchanged at that release).
 
 ### 0.9.34 (2026-05-08)
 
@@ -113,11 +119,6 @@ For **roadmap and planning**: [`TODO.md`](TODO.md) (open work at the top, full c
 - **Quick Start:** scripts-with-description lines are ordered **by name** for stable output.
 - **`docs/user-guide`:** tab overview, **exportHashes**/Mermaid wording; **SCREENSHOTS.md** + eingebettete **PNG-Screenshots** für alle sechs Konfig-Tabs (neben den SVG-Wireframes), Hinweise Lesbarkeit/GitHub-Vorschau.
 
-### 0.9.33 (2026-05-08)
-
-- **PDF export (Phase 5 — first slice):** optional **`puppeteer`** — **`pdfExportAfterGeneration`** in Admin **Advanced** and/or **`action.exportPdf`**; writes **`autodoc-{admin,user,onboarding}.pdf`** alongside HTML under **`/files/`** and mirrors to **Filesystem export path** when set (`lib/htmlToPdf.js`). Same Chromium sandbox flags as Mermaid CLI. Without **`puppeteer`** or on broken headless setups, PDF is skipped; core documentation generation continues.
-- **Admin:** **`jsonConfig`** + **i18n** (EN/DE/FR + English copy elsewhere) for PDF options and extended **export path** hint.
-
 ## License
 
 MIT License

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "autodoc",
-    "version": "0.9.37",
+    "version": "0.9.38",
     "news": {
+      "0.9.38": {
+        "en": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "de": "**Standard `documentationStatesMode`:** neue Instanzen starten mit **`metadata`** (vollständige Exporte nur unter **`/files/`**; States nur kurze Platzhalter) — schont die Objektdatenbank (z. B. Redis). **Bestehende** Instanzen behalten die Einstellung, bis Sie unter **Erweitert → Dokumentation in States** umstellen. Skripte mit Volltext: **`/files/`** oder Download-Aktionen — siehe Admin-Hilfe.",
+        "ru": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "pt": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "nl": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "fr": "**Valeur par défaut `documentationStatesMode` :** les **nouvelles** instances utilisent **`metadata`** (exports complets uniquement sous **`/files/`** ; états `documentation.*` en courtes valeurs de substitution) pour soulager la base d’objets (ex. **Redis**). Les instances **existantes** conservent le réglage jusqu’à modification dans **Avancé**. Scripts : texte complet via **`/files/`** ou actions de téléchargement — voir l’aide Admin.",
+        "it": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "es": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "pl": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "uk": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help.",
+        "zh-cn": "**Default `documentationStatesMode`:** new instances use **`metadata`** (full exports under **`/files/`** only; `documentation.*` states are short placeholders) to ease load on the object database (e.g. Redis). **Existing** instances keep their current setting until you change **Advanced → Dokumentation in States**. Scripts that need full text must read **`/files/`** or use download actions — see Admin help."
+      },
       "0.9.37": {
         "en": "**Tooling:** `runPdfExport` initializes the PDF digest map with a typed empty collection so **`npm run check`** (TypeScript) passes; no change to PDF export behavior.\n**Docs:** Adapter-neutral **[`docs/iobroker-adapter-references.md`](docs/iobroker-adapter-references.md)** linked from **`TODO.md`**, **`CONTRIBUTING.md`**, and the Cursor project rule; **`PLAN.md`** phase **5.x.1** aligned with **`TODO.md`** (MVP complete).",
         "de": "**Tooling:** `runPdfExport` initialisiert die PDF-Hash-Zuordnung typkorrekt, sodass **`npm run check`** (TypeScript) wieder durchläuft; kein geändertes Verhalten beim PDF-Export.\n**Docs:** Adapter-neutrale Referenz **[`docs/iobroker-adapter-references.md`](docs/iobroker-adapter-references.md)** in **`TODO.md`**, **`CONTRIBUTING.md`** und der Cursor-Projektregel verknüpft; **`PLAN.md`** Phase **5.x.1** an **`TODO.md`** angeglichen (MVP abgeschlossen).",
@@ -157,7 +170,7 @@
     "hideInstanceDetailsInMarkdown": false,
     "maxDocumentedInstances": 0,
     "maxStoredFiles": 3,
-    "documentationStatesMode": "full",
+    "documentationStatesMode": "metadata",
     "baseUrl": "",
     "maintenanceScoreCheckDescription": true,
     "maintenanceScoreCheckBaseUrl": true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.autodoc",
-  "version": "0.9.37",
+  "version": "0.9.38",
   "description": "On-demand documentation for ioBroker",
   "author": {
     "name": "crunchip77",