@helyx/cli 0.5.3 → 0.5.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.5.4
+
+### Patch Changes
+
+- 38c70f7: Ship maintained public documentation with the bot package and point newly generated self-host projects to its version-matched offline copy.
+
 ## 0.5.3
 
 ### Patch Changes

package/README.md

@@ -16,6 +16,10 @@ helyx self-host update --confirm
 
 `self-host init` retrieves the current reviewed catalogue from the fixed Helyx API endpoint, validates a downloaded build manifest against it, creates a new starter-project directory, pins the runtime and selected official modules, generates a lockfile with lifecycle scripts disabled, and writes checksums. The request has strict timeout, response-size, JSON-schema and official-package checks; no arbitrary catalogue URL or stale bundled fallback is accepted. Add `--install` only when the dependencies should also be installed locally. Unknown, unpublished, duplicated, stale or modified package selections fail closed.
 
+Generated projects include `DOCUMENTATION.md`, which points to the
+version-matched public documentation bundled with the installed `@helyx/bot`
+package.
+
 `self-host update --check` reads the current project and the reviewed catalogue from `api.helyx.gg`, then reports the complete compatible release-set change without writing files. `--confirm` backs up the managed metadata under `.helyx/backups`, updates exact core, CLI and selected live-module versions together, refreshes and validates the lockfile with lifecycle scripts disabled, and restores the original metadata if generation fails. Run `npm ci` and `npm run doctor` after applying an update. The updater never changes `.env` or customer database data.
 
 The package is published under the Helyx Source Available Licence. Generated projects contain deployment configuration and exact public npm dependencies; they do not contain Helyx source code or credentials.

package/dist/self-host/project-generator.js

@@ -9,6 +9,7 @@ const generatedFileNames = [
     ".gitignore",
     ".npmrc",
     "Dockerfile",
+    "DOCUMENTATION.md",
     "compose.yaml",
     "README.md",
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helyx/cli",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "Command-line tools for running and generating self-hosted Helyx deployments.",
   "keywords": [
     "helyx",

package/self-host-catalogue.json

@@ -1,14 +1,14 @@
 {
   "schemaVersion": 2,
-  "catalogueVersion": 46,
+  "catalogueVersion": 47,
   "core": {
     "package": "@helyx/bot",
-    "version": "0.4.38",
+    "version": "0.4.39",
     "availability": "published"
   },
   "generator": {
     "package": "@helyx/cli",
-    "version": "0.5.3",
+    "version": "0.5.4",
     "command": "helyx",
     "availability": "published"
   },
@@ -76,7 +76,7 @@
     {
       "id": "helyx.starboard",
       "package": "@helyx/module-starboard",
-      "version": "1.0.2",
+      "version": "1.0.3",
       "name": "Starboard",
       "description": "Highlight messages your community values.",
       "category": "Community",
@@ -721,7 +721,7 @@
     {
       "id": "helyx.achievements",
       "package": "@helyx/module-achievements",
-      "version": "1.0.6",
+      "version": "1.0.7",
       "name": "Achievements",
       "description": "Configurable member milestones, scores and optional rewards.",
       "category": "Gaming",
@@ -906,7 +906,7 @@
     {
       "id": "helyx.nexus-economy",
       "package": "@helyx/module-nexus-economy",
-      "version": "1.0.2",
+      "version": "1.0.3",
       "name": "Nexus Economy",
       "description": "Run a Nexus Exchange with server rewards and member inventory.",
       "category": "Gaming",

package/templates/self-host/DOCUMENTATION.md

@@ -0,0 +1,15 @@
+# Helyx documentation
+
+The public documentation matching this installed Helyx runtime ships inside
+`@helyx/bot`. Run `npm ci` first, then open:
+
+[`node_modules/@helyx/bot/documentation/README.md`](node_modules/@helyx/bot/documentation/README.md)
+
+That directory contains self-hosting guides, environment reference material,
+operator runbooks, and module-authoring instructions. It is replaced when the
+bot package is updated, so keep deployment-specific notes outside
+`node_modules`.
+
+The generated project's `.env.example` is the active configuration template.
+Never add the real `.env` file, credentials, database dumps, or private logs to
+a support bundle or source repository.

package/templates/self-host/README.md

@@ -8,6 +8,9 @@ This self-host starter was generated from the reviewed Helyx catalogue. It conta
 
 Package installation and module activation are separate. Installed feature modules start disabled for every Discord server. Enable and configure them only after the bot is running.
 
+The matching offline operator and module-author documentation is listed in
+[`DOCUMENTATION.md`](DOCUMENTATION.md) after the project has been generated.
+
 ## Requirements
 
 - A Discord application and bot token