@webship.co/workspace-docs 0.0.0-stage → 1.0.0-alpha1

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @webship.co/workspace-docs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The **Docs** workspace of the [Webship Workspace](https://github.com/webship/workspace) dashboard:
+the `docs/` folder (type `files`), its settings file (`core/config/workspace.docs.settings.yml`),
+its commands and its docs, as a plugin.
+
+## Use it
+
+```bash
+cd ~/workspace
+bash core/scripts/plugins.sh --require github:webship/workspace-docs
+bash core/scripts/plugins.sh --activate docs     # puts `docs` on the workspaces list of settings.yml
+bash core/scripts/plugins.sh --install docs      # the folder, its settings file (once), its commands, its docs (once)
+```
+
+The settings file and the docs are placed once and never overwritten: they hold what you put there.
+`--deactivate` takes the workspace off the list; the folder and its content stay.
+
+## The commands
+
+| Command |
+| --- |
+| `cmd-tool-backup-doc.sh` |
+| `cmd-tool-git-change-filemode-to-false.sh` |
+
+The bash functions these commands call live in the dashboard's `core/scripts/functions`.

package/commands/cmd-tool-backup-doc.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.docs.settings.yml);
+
+ARGPARSE_DESCRIPTION="Backup a doc"
+argparse "$@" <<ARGEOF || exit 1
+parser.add_argument('PROJECT_NAME',
+                    help='The name of the project.')
+ARGEOF
+
+shift $#;
+trim_project_name ;   # "v11x00b1/" -> "v11x00b1" — see functions/fun-project-name.sh
+
+backup_workspace_item "${PROJECT_NAME}" || exit 1 ;

package/commands/cmd-tool-git-change-filemode-to-false.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.docs.settings.yml);
+
+ARGPARSE_DESCRIPTION="Change a project's git core.fileMode to false"
+argparse "$@" <<ARGEOF || exit 1
+parser.add_argument('PROJECT_NAME',
+                    help='The name of the project.')
+ARGEOF
+
+shift $#;
+
+cd ${WORKSPACE_ROOT}/docs/${PROJECT_NAME} ;
+git config core.fileMode false ;

package/config/workspace.docs.settings.yml

@@ -0,0 +1,13 @@
+doc:
+  name: docs
+
+# What this folder's projects are, and which actions their rows offer:
+# sites | code | files | media | ai-items — see core/workspace-app/WORKSPACES.md.
+type: files
+
+# What the assistant is called on THIS workspace's page, and what its composer says when empty.
+# `default` in either means "whatever settings.yml says" — the global value, so a rename there
+# still reaches this page. Set a value here to override it for this workspace alone.
+assistant:
+  name: default
+  placeholder: default

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Docs workspace for Webship Workspace: the `docs/` folder as a plugin.
+ *
+ * What the package carries is placed by the installer from the manifest (the folder's settings file,
+ * its commands and its docs) and listed by --activate; the dashboard draws the workspace from the
+ * settings file like any other. Nothing to register at run time yet: this is where the folder's own
+ * rail buttons, row menus or assistant context would go.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+export declare const WORKSPACE_KEY = "docs";
+export declare function register(api: PluginApi): void;

package/dist/src/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * The Docs workspace for Webship Workspace: the `docs/` folder as a plugin.
+ *
+ * What the package carries is placed by the installer from the manifest (the folder's settings file,
+ * its commands and its docs) and listed by --activate; the dashboard draws the workspace from the
+ * settings file like any other. Nothing to register at run time yet: this is where the folder's own
+ * rail buttons, row menus or assistant context would go.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WORKSPACE_KEY = void 0;
+exports.register = register;
+exports.WORKSPACE_KEY = 'docs';
+function register(api) {
+    api.addAssistantContext(() => `The docs/ workspace is the Docs workspace (a plugin, @webship.co/workspace-docs); its commands are the cmd-*.sh scripts in that folder.`);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAMH,4BAEC;AAJY,QAAA,aAAa,GAAG,MAAM,CAAC;AAEpC,SAAgB,QAAQ,CAAC,GAAc;IACrC,GAAG,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,yIAAyI,CAAC,CAAC;AAC3K,CAAC"}

package/docs/AGENTS.md

@@ -0,0 +1,21 @@
+# Docs
+
+Documentation projects, and what is generated from them — PDFs, HTML, screenshots.
+
+Part of the **Webship Workspace** (`~/workspace`), a DDEV-only harness. The rules in the root
+`CLAUDE.md` apply here too; what follows is what is specific to this folder.
+
+## What an item is here
+
+A markdown document, plus whatever has been generated FROM it — a PDF, an HTML render, a
+screenshot. The generated files sit beside the source and are listed as artifacts.
+
+## Commands here
+
+```bash
+bash cmd-tool-backup-doc.sh                           # Bootstrap.
+bash cmd-tool-git-change-filemode-to-false.sh         # Bootstrap.
+```
+
+Every one locates the workspace from its own path, so there is nothing to export and nothing to
+install. `--help` on any of them lists its arguments.

package/docs/CLAUDE.md

@@ -0,0 +1,7 @@
+# Docs — workspace context
+
+You are inside the **docs** workspace of the Webship Workspace (`~/workspace`).
+
+@AGENTS.md
+
+The rules in it apply to everything under this folder, however deep.

package/docs/README.md

@@ -0,0 +1,6 @@
+# Docs
+--
+
+* You could place your docs.
+
+**Google Drive.** `bash cmd-tools-google-drive-sync.sh` (or the **Sync to Drive** button) pushes this folder to its Google Drive folder, new and changed files only, never deleting; `--dry-run` previews and `-a register` adds the Google Drive MCP server to Claude Code. Settings: `google_drive:` in `core/config/settings.yml`.

package/features/docs.feature

@@ -0,0 +1,12 @@
+Feature: The Docs workspace plugin
+  Once the plugin is activated and installed, the docs workspace is on the dashboard, and the
+  Plugins page lists the plugin with its four steps.
+
+  Scenario: The workspace page is there
+    Given I am on "/docs"
+     Then I should see "Docs"
+
+  Scenario: The plugin is listed on the Plugins page
+    Given I am on "/settings/plugins"
+     Then I should see "Docs"
+      And I should see "@webship.co/workspace-docs"

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@webship.co/workspace-docs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "The Docs workspace for Webship Workspace: the `docs/` folder (type files), its settings file, its 2 commands and its docs, activated as a plugin.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webship/workspace-docs.git"
+  },
+  "files": [
+    "dist/src",
+    "commands",
+    "config",
+    "docs",
+    "features",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "npm run build && node --test dist/tests/*.test.js",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "workspacePlugin": {
+    "name": "docs",
+    "label": "Docs",
+    "workspace": {
+      "key": "docs",
+      "settingsTemplate": "config/workspace.docs.settings.yml",
+      "files": [
+        "commands/cmd-tool-backup-doc.sh",
+        "commands/cmd-tool-git-change-filemode-to-false.sh"
+      ],
+      "docs": [
+        "docs/AGENTS.md",
+        "docs/CLAUDE.md",
+        "docs/README.md"
+      ]
+    },
+    "features": [
+      "features/docs.feature"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@webship.co/workspace-plugin-api": "^1.0.0-alpha1",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}