viteboard 0.1.1 → 0.1.3

package/content/machine/llms.txt

@@ -0,0 +1,31 @@
+# ViteBoard
+
+> Local-first documentation workspace and infinite-canvas board system. The source of truth is plain files on disk.
+
+Use your normal filesystem tools to read and write project files. Use ViteBoard's HTTP surface to discover workspace roots, understand board/document grammar, and coordinate live editing with locks and presence.
+
+Always reuse the exact origin the user gives you, for example `http://localhost:5173`. Do not silently swap it for `127.0.0.1`, another hostname, or another port because the running ViteBoard instance may only be bound on one loopback interface.
+
+## Core machine docs
+
+- [ViteBoard authoring guide](/viteboard-guide.md): How docs roots, boards, embeds, visual layout, locks, and live coordination work.
+- [Board schema v1](/board-v1.schema.json): JSON Schema for `.board.json` files.
+- [Example board](/viteboard-example.board.json): One complete valid ViteBoard board.
+
+## Capability model
+
+- Capabilities are managed directory branches under `capabilities/` inside a docs root.
+- Human entrypoint: `index.md`
+- Machine entrypoint: `llms.txt`
+- The rest of the branch may contain markdown, scripts, helpers, assets, examples, and nested directories.
+
+## App discovery
+
+- [Workspace listing](/__api/workspace): Registered projects and docs roots.
+- [Machine manifest](/.well-known/viteboard.json): Route templates and coordination endpoints.
+
+The machine can also open the same wiki, document, board, capability, and directory routes a human uses. See the guide for the exact route templates.
+
+## Optional
+
+- [Machine guide source](https://gitlab.com/ajsib/viteboard): Project repository homepage.

package/content/machine/viteboard.json

@@ -0,0 +1,62 @@
+{
+  "name": "ViteBoard",
+  "appVersion": "0.1.3",
+  "machineVersion": 1,
+  "summary": "Local-first documentation and infinite-canvas boards stored as plain files.",
+  "connectionHints": {
+    "originPolicy": "Reuse the exact origin supplied by the user or discovered from the current page. Do not rewrite localhost to 127.0.0.1 or change the port.",
+    "reason": "The local ViteBoard server may bind only one loopback interface, so localhost and 127.0.0.1 are not always interchangeable."
+  },
+  "discovery": {
+    "llms": "/llms.txt",
+    "guide": "/viteboard-guide.md",
+    "boardSchema": "/board-v1.schema.json",
+    "exampleBoard": "/viteboard-example.board.json"
+  },
+  "capabilities": {
+    "branchModel": "directory",
+    "entrypoints": {
+      "human": "index.md",
+      "machine": "llms.txt"
+    },
+    "notes": [
+      "A capability is a managed directory branch beneath capabilities/ inside a docs root.",
+      "The branch, not a single file, is the capability unit.",
+      "Machines should prefer llms.txt as the first machine-facing entrypoint when present."
+    ]
+  },
+  "routes": {
+    "workspaceHome": "#/",
+    "projectWiki": "#/project/{projectId}",
+    "projectBoards": "#/project/{projectId}/boards",
+    "doc": "#/root/{rootId}/docs/{path}",
+    "boardList": "#/root/{rootId}/boards",
+    "board": "#/root/{rootId}/boards/{boardId}",
+    "capabilities": "#/root/{rootId}/capabilities",
+    "capabilityDoc": "#/root/{rootId}/capabilities/{path}",
+    "directoryWiki": "#/root/{rootId}/directory/{path}"
+  },
+  "api": {
+    "workspace": "/__api/workspace",
+    "projectTree": "/__api/project-tree?projectId={projectId}",
+    "tree": "/__api/tree?rootId={rootId}",
+    "file": "/__api/file?rootId={rootId}&path={path}",
+    "board": "/__api/board?rootId={rootId}&id={boardId}",
+    "registerProject": "/__api/workspace/project",
+    "ensureDocsRoot": "/__api/workspace/project/docs-root",
+    "createDocsFolder": "/__api/workspace/project/create-docs-folder",
+    "presence": "/__api/actors/session",
+    "heartbeat": "/__api/actors/heartbeat",
+    "locksAcquire": "/__api/locks/acquire",
+    "locksRelease": "/__api/locks/release",
+    "events": "/__api/events"
+  },
+  "coordination": {
+    "mode": "cooperative",
+    "notes": [
+      "Register a live actor session if you want the app to reflect connectedness.",
+      "Acquire a lock before writing a Markdown document or board so the human UI becomes read-only.",
+      "Release the lock after writing and let the app surface stale/reload indicators."
+    ]
+  }
+}