@comchatx/cx-board 0.2.0 → 0.3.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
1
  A board beside the chat, where cx leaves what the seller is to read.
2
2
 
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.
3
+ Each file is a Markdown file in a tab, one directory per tab under `/tenant/board/<person>/`, its first heading its title.
4
4
 
5
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.
@@ -0,0 +1,5 @@
1
+ 对话旁的一块看板,cx 把要给卖家看的内容留在上面。
2
+
3
+ 看板上的每一条,都是某个标签页里的一个 Markdown 文件,文件的第一个标题就是这一条的标题。每个标签页对应 `/tenant/board/<person>/` 下的一个目录。
4
+
5
+ 这个包只有一个技能,告诉 cx 看板在哪里、看板上的文件写什么。安装这个包期间,看板这一栏由 ComChatX 显示。卖家在看板上作答的待办、建议和提问,属于和这个包一起安装的模块 `@comchatx/cx-board-tasks`。
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@comchatx/cx-board",
3
- "version": "0.2.0",
4
- "description": "A board beside the chat, where cx leaves what it found, changed, proposes and asks.",
3
+ "version": "0.3.0",
4
+ "description": "A board beside the chat for what cx and plugins make.",
5
5
  "license": "MIT",
6
6
  "author": "ComChatX",
7
7
  "homepage": "https://github.com/comchatx/cx-board#readme",
@@ -20,14 +20,15 @@
20
20
  ]
21
21
  },
22
22
  "files": [
23
- "skills"
23
+ "skills",
24
+ "README.zh-CN.md"
24
25
  ],
25
26
  "scripts": {
26
27
  "typecheck": "tsc --noEmit",
27
28
  "test": "vitest run"
28
29
  },
29
30
  "comchatx": {
30
- "about": "在对话旁设一块看板,cx 把发现、改动、建议和问题留在上面。",
31
+ "about": "在对话旁设一块看板,cx 和插件做出的东西都放在上面。",
31
32
  "mark": {
32
33
  "line": "clipboard"
33
34
  },
@@ -1,13 +1,17 @@
1
1
  ---
2
2
  name: cx-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.
3
+ description: The seller's board, a column beside the chat that shows Markdown files as cards. Use when you leave the seller something to read later, such as a finding, a report or a draft.
4
4
  ---
5
5
 
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.
6
+ The board is the seller's directory under `/tenant/board/`; the computer makes it for the seller. It holds directories and nothing else: each directory is a tab, named by its directory's name, and the seller sees the tabs by name in a column beside the chat. Each Markdown file in a tab, at any depth under it, is a card: the seller sees when it was written, its title, and your words, drawn as your answers in the chat are. Anyone may leave one: you, a plugin's skill, a script. A plugin's skill names the tab it writes to.
7
+
8
+ ## A tab
9
+
10
+ When the seller asks for a tab of their own, make a directory of the name they give under the board. A file directly in the board's directory, outside every tab, is not drawn.
7
11
 
8
12
  ## A file on the board
9
13
 
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:
14
+ Put a file in its tab's directory and name it `<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 title is the `title` of its front matter, else its first heading; your words follow:
11
15
 
12
16
  ```markdown
13
17
  # The blue kettle's price fell to $24.99 on Amazon US
@@ -15,16 +19,14 @@ One file is one Markdown file under `todo/`, named `<time>-<slug>.md`, where `<t
15
19
  Your words.
16
20
  ```
17
21
 
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.
22
+ A file with no title is named by its file name. Your words are a few lines: the figures that matter, one reason, and where they come from. Nothing on the page marks what cannot be undone; only the file's own words say it, once, in a line of its own.
19
23
 
20
- Your words are a few lines: the figures that matter, one reason, and where they come from.
24
+ The board shows its directories as they are. A file is yours to change, move or remove when the seller asks, and a tab is too.
21
25
 
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.
26
+ ## After you leave a file
23
27
 
24
- ## The page's names
28
+ When a turn of yours leaves a new file, the column opens beside the chat by itself on the tab the file landed in, unless the seller shut it that turn. Say in your reply that you put a file on the board, by its title and its tab, so the seller knows where to look.
25
29
 
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.
27
-
28
- ## What the seller does with a file
30
+ ## The page's names
29
31
 
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.
32
+ Call the board by the name the seller sees, in the seller's language: 看板 / the board.