@maplab/hyperdoc 0.2.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +18543 -802
- package/dist/index.js.map +1 -1
- package/dist/prompts/agent.txt +25 -3
- package/dist/web/apple-touch-icon.png +0 -0
- package/dist/web/assets/index-BTUlbGUk.js +725 -0
- package/dist/web/assets/index-CheWhgv9.css +1 -0
- package/dist/web/favicon.png +0 -0
- package/dist/web/index.html +4 -3
- package/dist/web/logo.png +0 -0
- package/package.json +2 -1
- package/dist/web/assets/index-DMhiJVmN.js +0 -549
- package/dist/web/assets/index-KIh2MATB.css +0 -1
package/dist/prompts/agent.txt
CHANGED
|
@@ -2,7 +2,8 @@ Hyperdoc Agent Spec
|
|
|
2
2
|
|
|
3
3
|
Files:
|
|
4
4
|
- Markdown lives in `.md` files.
|
|
5
|
-
- Data tables live in `.json` files.
|
|
5
|
+
- Data tables live in `.table.json` files.
|
|
6
|
+
- Task boards live in `.tasks.json` files.
|
|
6
7
|
- Project metadata lives in `.hyperdoc/project.json` (optional). It can include a `name` field for the project. Update this file if the user asks to rename the project.
|
|
7
8
|
- Archived documents live in `.hyperdoc/archive/`. Ignore archived content unless the user explicitly asks to view or restore archived items.
|
|
8
9
|
- Deleted documents live in `.hyperdoc/trash/`. Ignore trash contents unless the user explicitly asks to view or restore them.
|
|
@@ -13,7 +14,7 @@ Tables (JSON files):
|
|
|
13
14
|
- Values must be strings only (no nested objects/arrays).
|
|
14
15
|
- Rows can link to docs via `@path.md` values.
|
|
15
16
|
|
|
16
|
-
Example table (`projects.json`):
|
|
17
|
+
Example table (`projects.table.json`):
|
|
17
18
|
{
|
|
18
19
|
"data": [
|
|
19
20
|
{ "name": "Project 1", "details": "@project-1.md", "status": "Active", "createdAt": "1970-01-01" },
|
|
@@ -29,8 +30,29 @@ Notes:
|
|
|
29
30
|
- `metadata` is optional. Omit it unless you explicitly want a default sort/group.
|
|
30
31
|
- `sortBy` and `groupBy` are optional inside `metadata`.
|
|
31
32
|
|
|
33
|
+
Tasks (JSON files):
|
|
34
|
+
- Must be valid JSON: an object with `data` and `statuses`. `metadata` and `view` are optional.
|
|
35
|
+
- `statuses` (required, array of strings) defines the columns/statuses for the board view. Empty columns persist.
|
|
36
|
+
- Each item has `label` (required), `status` (optional, defaults to "todo"), `priority` (optional 0-4: 0=None, 1=Urgent, 2=High, 3=Medium, 4=Low), `tags` (optional array of strings), and `linkedDoc` (optional string, name of another document in the project).
|
|
37
|
+
- Status is freeform. "done" marks a task complete; "cancelled" marks it struck-through.
|
|
38
|
+
- Supports list view (checkboxes, grouping, sorting, filtering) and board/kanban view (columns by status).
|
|
39
|
+
- `view` (optional) persists view state: `groupBy` (status|priority|tag), `sortBy` (priority|status|label), `sortDesc`, and `filters`.
|
|
40
|
+
|
|
41
|
+
Example task board (`roadmap.tasks.json`):
|
|
42
|
+
{
|
|
43
|
+
"data": [
|
|
44
|
+
{ "label": "Design the schema", "status": "done", "priority": 2, "tags": ["backend"] },
|
|
45
|
+
{ "label": "Build the UI", "status": "in progress", "priority": 1, "tags": ["frontend"] },
|
|
46
|
+
{ "label": "Write tests", "status": "todo", "priority": 3 }
|
|
47
|
+
],
|
|
48
|
+
"statuses": ["todo", "in progress", "done"],
|
|
49
|
+
"metadata": {
|
|
50
|
+
"tags": ["sprint-1"]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
32
54
|
Links:
|
|
33
|
-
- Markdown can reference tables or docs via `@path` (e.g., `@projects.json`).
|
|
55
|
+
- Markdown can reference tables or docs via `@path` (e.g., `@projects.table.json`).
|
|
34
56
|
|
|
35
57
|
Validation:
|
|
36
58
|
- Run `hyper validate --root <docs-root>` to check repo structure and JSON tables.
|
|
Binary file
|