@huaweidevtools/aishell-dsh-handbook 0.0.15 → 0.0.16

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
@@ -40,13 +40,16 @@ user's actual question.
40
40
  The full text lives in [`src/prompt.ts`](src/prompt.ts); the block above is its
41
41
  shape, not its wording.
42
42
 
43
- ## Why a list of topics, not an essay
43
+ ## Why a list of topics
44
44
 
45
- Each topic is one question a user can ask, answered under its own heading.
46
- Growing this package means **appending a topic** — never editing an opening
47
- sentence that counts them. An earlier draft opened with "AI Shell has two
48
- behaviours worth being able to explain", which made a third behaviour a rewrite
49
- of the first line. `tests/handbook.spec.ts` fails on that shape coming back.
45
+ Each topic is one question a user can ask, answered under its own heading, and
46
+ nothing in the text counts them. Growing this package is therefore an append: a
47
+ new capability becomes a new heading, and no existing sentence has to be
48
+ rewritten to accommodate it.
49
+
50
+ A preamble stating how many topics there are would make every addition an edit
51
+ to the line introducing all of them — the one part of the file that has to stay
52
+ true as it grows. `tests/handbook.spec.ts` fails on that shape.
50
53
 
51
54
  ## Why the UI facts are stated as facts
52
55
 
package/lib/index.js CHANGED
@@ -2,14 +2,14 @@
2
2
  /**
3
3
  * Position of the handbook in the assembled prompt.
4
4
  *
5
- * A number, not a name, because the framework's placement table is closed:
6
- * `PromptSectionOrderName` is `keyof` a fixed constant, and there is no slot
7
- * for product background. `aishell-huaweicloud-docs` documents the same
8
- * departure at the same kind of position.
5
+ * A number because the framework's placement table is closed:
6
+ * `PromptSectionOrderName` is `keyof` a fixed constant, and no entry names
7
+ * product background. `aishell-huaweicloud-docs` resolves its own position the
8
+ * same way, one step ahead of this one.
9
9
  *
10
- * 110 puts this immediately after that pointer (100), both inside the empty gap
11
- * the table leaves between the persona prefix (0) and the first policy (500).
12
- * The two are one band: read where to look things up, then how this product
10
+ * 110 puts this immediately after that pointer (100), both inside the gap the
11
+ * table leaves between the persona prefix (0) and the first policy (500). The
12
+ * two are one band: read where to look things up, then how this product
13
13
  * behaves, then what you are asked to reason about.
14
14
  */
15
15
  const HANDBOOK_ORDER = 110;
@@ -12,14 +12,14 @@
12
12
  * does not exist — or says it does not know, which is worse than the truth for
13
13
  * a fact this stable.
14
14
  *
15
- * ## Why the text is a list of topics, not an essay
15
+ * ## Why the text is a list of topics
16
16
  *
17
17
  * Each topic is one question a user can ask, answered on its own, under its own
18
- * heading. Growing this file means appending a topic; it must never mean
19
- * editing an opening sentence that counts them. An early draft opened with
20
- * "AI Shell has two behaviours worth being able to explain", which made adding
21
- * a third behaviour a rewrite of the first line rather than an addition at the
22
- * end.
18
+ * heading, and nothing in the text counts them. Growth is therefore an append:
19
+ * a new capability becomes a new heading, and no existing sentence has to be
20
+ * rewritten to accommodate it. A preamble that stated how many topics there
21
+ * are would make every addition an edit to the line introducing all of them,
22
+ * which is the one part of this file that has to stay true as it grows.
23
23
  *
24
24
  * ## Why the UI facts are stated as facts
25
25
  *
@@ -42,14 +42,14 @@ import type { Context } from '@deepseek-ai/cordis';
42
42
  /**
43
43
  * Position of the handbook in the assembled prompt.
44
44
  *
45
- * A number, not a name, because the framework's placement table is closed:
46
- * `PromptSectionOrderName` is `keyof` a fixed constant, and there is no slot
47
- * for product background. `aishell-huaweicloud-docs` documents the same
48
- * departure at the same kind of position.
45
+ * A number because the framework's placement table is closed:
46
+ * `PromptSectionOrderName` is `keyof` a fixed constant, and no entry names
47
+ * product background. `aishell-huaweicloud-docs` resolves its own position the
48
+ * same way, one step ahead of this one.
49
49
  *
50
- * 110 puts this immediately after that pointer (100), both inside the empty gap
51
- * the table leaves between the persona prefix (0) and the first policy (500).
52
- * The two are one band: read where to look things up, then how this product
50
+ * 110 puts this immediately after that pointer (100), both inside the gap the
51
+ * table leaves between the persona prefix (0) and the first policy (500). The
52
+ * two are one band: read where to look things up, then how this product
53
53
  * behaves, then what you are asked to reason about.
54
54
  */
55
55
  export declare const HANDBOOK_ORDER = 110;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@huaweidevtools/aishell-dsh-handbook",
3
3
  "description": "Tells LLM how AI Shell works — where feedback goes, what the read-only switch means, how to extend the harness",
4
- "version": "0.0.15",
4
+ "version": "0.0.16",
5
5
  "publishConfig": {
6
6
  "access": "public"
7
7
  },