@comchatx/cx-board 0.1.2 → 0.2.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/README.md CHANGED
@@ -1,5 +1,5 @@
1
- A board beside the chat, where cx leaves what it found, what it changed, what it proposes and what it asks.
1
+ A board beside the chat, where cx leaves what the seller is to read.
2
2
 
3
- Each entry is a Markdown file cx writes under `/tenant/board/<person>/todo/`. The seller reads it in a column at the chat's right, marks it read or dismisses it, and answers what cx asks. Every answer goes to cx at once, as one message. What is done stays readable under `done/`, and nothing on the board is deleted.
3
+ Each file is a Markdown file cx writes under `/tenant/board/<person>/todo/`, its first heading its title. The seller reads it in a column at the chat's right and marks it read. What is done stays readable under `done/`, and nothing on the board is deleted.
4
4
 
5
- The package holds one skill, which tells cx where the board is, what an entry's file holds and how the seller's answers come back. The column is drawn by ComChatX while the package is installed.
5
+ The package holds one skill, which tells cx where the board is and what a file on it holds. The column is drawn by ComChatX while the package is installed. To-dos, proposals and questions the seller answers on the board are the module's, `@comchatx/cx-board-tasks`, installed beside this package.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@comchatx/cx-board",
3
- "version": "0.1.2",
3
+ "version": "0.2.0",
4
4
  "description": "A board beside the chat, where cx leaves what it found, changed, proposes and asks.",
5
5
  "license": "MIT",
6
6
  "author": "ComChatX",
@@ -1,58 +1,30 @@
1
1
  ---
2
2
  name: cx-board
3
- description: The seller's board, where you leave what you found, what you changed, what you propose and what you ask. Use when you leave something for the seller to read or answer, and when the seller's message answers entries on the board.
3
+ description: The seller's board, where you leave something for the seller to read beside the chat. Use when you leave the seller a finding, a change you made or a report to read later.
4
4
  ---
5
5
 
6
- The board is the one directory under `/tenant/board/`; the computer makes it for the seller. What waits for the seller is under its `todo/`, and what the seller has done with is under its `done/`. The seller reads the board in a column beside the chat; nothing on it reaches the seller any other way.
6
+ The board is the seller's directory under `/tenant/board/`; the computer makes it for the seller. What waits for the seller is under its `todo/`, and what the seller has done with is under its `done/`. The seller reads the board in a column beside the chat; nothing on it reaches the seller any other way. When a turn of yours leaves a new file on the board, the column may open beside the chat by itself.
7
7
 
8
- ## An entry
8
+ ## A file on the board
9
9
 
10
- One entry is one Markdown file under `todo/`, named `<time>-<slug>.md`, where `<time>` is when you wrote it as `YYYYMMDD-HHMMSS` in UTC and `<slug>` is a few lowercase words joined by `-`. It opens with front matter, then your words for the seller, drawn as your answers in the chat are:
10
+ One file is one Markdown file under `todo/`, named `<time>-<slug>.md`, where `<time>` is when you wrote it as `YYYYMMDD-HHMMSS` in UTC and `<slug>` is a few lowercase words joined by `-`. Its first line is a heading, which is the one line the seller reads first; your words for the seller follow, drawn as your answers in the chat are:
11
11
 
12
12
  ```markdown
13
- ---
14
- kind: proposal
15
- title: Lower the price of the blue kettle to $24.99
16
- at: 2026-10-27T02:14:00Z
17
- ---
13
+ # The blue kettle's price fell to $24.99 on Amazon US
18
14
 
19
15
  Your words.
20
16
  ```
21
17
 
22
- - `kind` is one of five:
23
- - `finding`: something you found. The seller reads it.
24
- - `change`: a change you already made. The seller reads it.
25
- - `proposal`: something you would do, and have not done. The seller may agree.
26
- - `choice`: a question with options. Add `options:`, then one `- option` line each, at most twelve, each one line.
27
- - `input`: a question the seller answers in words. Add `hint:`, one line shown in the empty field.
28
- - `title` is the one line the seller reads first.
29
- - `at` is when you wrote it, in ISO 8601 with its offset.
30
-
31
- A file without these three, or with another kind, is drawn as a file name and a time alone.
18
+ The seller sees when the file was written, its heading as its title, and your words. A file with no heading is named by its file name. A Markdown file a plugin writes directly in the seller's board directory waits as one under `todo/` does. A hand-over names such a file `../<name>`, its path from `todo/`; once handed over it sits under `done/` as `<name>`, or `<name>-2`, `-3` when another had the name, as a file from `todo/` does.
32
19
 
33
- Your words under the front matter are a few lines: the figures that matter, one reason, and where they come from.
20
+ Your words are a few lines: the figures that matter, one reason, and where they come from.
34
21
 
35
- Nothing on the page marks what cannot be undone; only the entry's own words say it, once, in a line of its own.
22
+ Nothing on the page marks what cannot be undone; only the file's own words say it, once, in a line of its own.
36
23
 
37
24
  ## The page's names
38
25
 
39
- Call the board and its parts by the names the seller sees, in the seller's language: 看板 / the board, 待处理 / To do, 已处理 / Done, 已读 / Mark as read, 忽略 / Dismiss, 交给 cx / Send to cx.
40
-
41
- ## What the seller does with an entry
42
-
43
- - **已读 / Mark as read**, on a finding or a change: the file moves to `done/`. You are not told.
44
- - **忽略 / Dismiss**, on a proposal, a choice or an input: the file moves to `done/`. You are not told. A dismissed proposal is not agreed, and nothing is done for it.
45
- - **An answer**: the seller agrees to a proposal, picks an option or types into an input, and sends the answers with 交给 cx / Send to cx. The files move to `done/`.
26
+ Call the board and its parts by the names the seller sees, in the seller's language: 看板 / the board, 待处理 / To do, 已处理 / Done, 已读 / Mark as read.
46
27
 
47
- A file moved to `done/` keeps every line you wrote and gains `done` (`read`, `dismissed`, `answered` or `timed_out`), `doneAt` and, when one went, `answer`. Nothing on the board is deleted.
48
-
49
- ## The seller's answers
50
-
51
- Answers come to you as one message from the seller. Each entry answered is a marker naming its file and the time of the version answered, then the seller's words for it:
52
-
53
- ```text
54
- <board file="20261027-021400-lower-kettle-price.md" modified="1761531240000">Lower the price of the blue kettle to $24.99</board>
55
- Go ahead.
56
- ```
28
+ ## What the seller does with a file
57
29
 
58
- The words inside the marker are the entry's title. The words under it are the seller's: 同意 / Go ahead. for a proposal, the option's own words for a choice, and what was typed for an input. Read the entry's file under `done/` for what you wrote.
30
+ **已读 / Mark as read**: the file moves to `done/`. You are not told. A file moved to `done/` keeps every line you wrote and gains front matter with `done: read` and `doneAt`. Nothing on the board is deleted.