tirtc-device-builder 0.11.5 → 0.11.6

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.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tirtc-device-builder",
3
- "version": "0.11.5",
3
+ "version": "0.11.6",
4
4
  "description": "Codex workflows for building, validating, and documenting TiRTC device firmware across supported chip platforms.",
5
5
  "author": {
6
6
  "name": "TangeAI",
package/CHANGELOG.md CHANGED
@@ -2,6 +2,14 @@
2
2
 
3
3
  This project follows Semantic Versioning.
4
4
 
5
+ ## 0.11.6
6
+
7
+ - Add field-log triage gates for Beken HTTP business failures, generation-bound
8
+ remote closes, AI tail-audio ordering, worker exit versus processor faults,
9
+ FT6336 input faults, room-leave evidence and contact-shortcut intent.
10
+ - Improve the project-documentation Skill with reader-task section ordering and
11
+ small, decision-focused diagram guidance.
12
+
5
13
  ## 0.11.5
6
14
 
7
15
  - Add the `tirtc-project-docs` Skill for designing and reviewing public
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tirtc-device-builder",
3
- "version": "0.11.5",
3
+ "version": "0.11.6",
4
4
  "description": "Install and run TiRTC device-development Agent Skills across popular coding clients.",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -1 +1 @@
1
- 0.11.5
1
+ 0.11.6
@@ -1,7 +1,7 @@
1
1
  # LCKFB BK7258 XiaoTai lessons
2
2
 
3
3
  Use this case study for BK7258 XiaoTai/TiRTC ports and reviews. It distils the
4
- failures fixed in `lckfb-bk7258-xiaotai` through source commit `05d3180`. These
4
+ failures fixed in `lckfb-bk7258-xiaotai` through source commit `6ec080f`. These
5
5
  are gates, not a generic board profile: retain the decisions, but use the exact
6
6
  numbers only when the target matches the identity below.
7
7
 
@@ -199,3 +199,36 @@ state transitions but not complete network inputs or responses.
199
199
  Contract tests must keep those full-payload format strings behind `BK_LOGD` or
200
200
  an equivalent DEBUG guard and reject them at INFO/WARN/ERROR. Treat DEBUG logs as
201
201
  sensitive development artifacts and keep them out of source control.
202
+
203
+ ## Field-log triage gate
204
+
205
+ Reconstruct a failure by monotonic device time and session generation. Terminal
206
+ receive timestamps can batch output and do not establish firmware ordering.
207
+ Separate these layers before changing code:
208
+
209
+ - transport success from business success: HTTP 200 can still carry a rejected
210
+ business code such as an offline target;
211
+ - semantic completion from connection closure: TiRTC `-40008` is normal only
212
+ for the same generation after an explicit hangup or `end_session`; otherwise
213
+ retain it as an error;
214
+ - locally buffered AI tail from unsent platform audio: after `end_session`, gate
215
+ uplink and drain queued playback before teardown. If the platform closes in
216
+ less than one negotiated audio-frame interval, firmware cannot recover audio
217
+ that never arrived. Require the platform to send the complete final utterance
218
+ before the end command and transport close;
219
+ - worker cleanup text from a processor crash: an SDK thread-exit warning alone
220
+ is not reboot evidence. Require a Fault/watchdog record or a new boot sequence;
221
+ - touch-controller I/O failures from media faults: diagnose FT6336 read errors,
222
+ invalid touch IDs and missing UP events at the board adapter. Submit dangerous
223
+ tap actions once on DOWN and preserve DOWN/UP pairing for PTT.
224
+
225
+ For room exit, require all three observable results: the leave API succeeds,
226
+ local media closes, and the refreshed assignment is absent. A page transition
227
+ alone does not prove that the device left the room. For contact shortcuts,
228
+ verify the selected contact class as well as list position; a touch-home WeChat
229
+ shortcut and a physical `contacts[0]` shortcut are distinct product intents.
230
+
231
+ Lock each corrected business rule in the platform-neutral product tests and the
232
+ adapter ordering in a board contract test. Use the repository's documented
233
+ test entrypoint after locating it; do not invent a generic
234
+ `tools/run_host_tests.sh` path across projects.
@@ -1 +1 @@
1
- 0.11.5
1
+ 0.11.6
@@ -25,6 +25,10 @@ area when the repository defines one.
25
25
  4. Map every technical claim to a source. Read
26
26
  [evidence and technical claims](references/evidence.md) when the work covers
27
27
  hardware, media, tools, builds, releases, or validation status.
28
+ 5. State the primary reader task for every entry document before drafting its
29
+ sections. Read [readability and diagrams](references/readability-and-diagrams.md)
30
+ for root entrypoints, long guides, workflow documents, or any proposed
31
+ visualization.
28
32
 
29
33
  ## Select the document layer
30
34
 
@@ -56,6 +60,19 @@ interfaces, responsibilities, commands, and decision points over source-tree
56
60
  tourism. Explain an unavoidable acronym on first use. Keep one topic per
57
61
  paragraph and make commands, warnings, status, and next actions easy to scan.
58
62
 
63
+ Order sections by the reader's next decision, not by the order in which facts
64
+ were discovered. A quick-start normally moves from board/artifact choice to
65
+ flashing, first experience, and only then source development. An architecture
66
+ guide moves from product scope to layers, runtime flows, contracts, extension,
67
+ and verification. A contribution guide moves from prerequisites to change
68
+ classification, applicable constraints, tests, and submission.
69
+
70
+ Use a diagram only when it makes a multi-step flow, hierarchy, or branching
71
+ decision materially easier to understand. Keep it small, introduce it in prose,
72
+ and retain critical constraints in nearby text. Do not repeat the same complete
73
+ sequence as both a numbered list and a diagram. Keep complex architecture out
74
+ of the quick-start README unless it is necessary to complete the first run.
75
+
59
76
  Use available specialist Skills when they materially apply:
60
77
 
61
78
  - `research` for facts that require official external sources and citations;
@@ -78,9 +95,10 @@ repository's documentation, manifest, and host-test gates. A passing structure
78
95
  test does not upgrade build evidence into hardware proof.
79
96
 
80
97
  Review the Chinese documents for facts, terminology, navigation, paragraph
81
- shape, and duplicated sources of truth. Present the Chinese result for approval
82
- when requested. Completion for this phase means all requested Chinese documents
83
- and checks are complete, with English files still untouched.
98
+ shape, section order, diagram purpose, and duplicated sources of truth. Present
99
+ the Chinese result for approval when requested. Completion for this phase means
100
+ all requested Chinese documents and checks are complete, with English files
101
+ still untouched.
84
102
 
85
103
  ## Synchronize English after approval
86
104
 
@@ -1 +1 @@
1
- 0.11.5
1
+ 0.11.6
@@ -0,0 +1,77 @@
1
+ # Readability and diagrams
2
+
3
+ Use this reference when drafting or auditing root entrypoints, long guides,
4
+ workflows, architecture explanations, or Mermaid diagrams.
5
+
6
+ ## Start from the reader task
7
+
8
+ Give each document one primary promise. The opening should tell the reader what
9
+ they can accomplish there and point elsewhere for broader detail. Arrange
10
+ sections in prerequisite order so the reader never needs information that is
11
+ introduced later.
12
+
13
+ Common sequences are guidance, not fixed templates:
14
+
15
+ - Quick experience: identify board and artifact, verify the bundle, flash it,
16
+ provision and try the product, then offer source-build and deeper links.
17
+ - Architecture: establish product scope, show layers and ownership, explain
18
+ runtime or media flows, state contracts, show extension paths, then explain
19
+ evidence and verification.
20
+ - Contribution: prepare the environment, classify the change, read the rules
21
+ that apply to that class, implement it, run proportional tests, update
22
+ documentation, and complete submission checks.
23
+
24
+ Do not preserve an existing section order merely because every individual
25
+ section is accurate. A source-download chapter placed in the middle of a binary
26
+ quick-start is still a usability defect.
27
+
28
+ ## Shape paragraphs and sections
29
+
30
+ Introduce context or a decision before commands, tables, or diagrams. Keep one
31
+ main idea per paragraph. Put the result, warning, or next step next to the action
32
+ it qualifies instead of collecting all caveats at the end.
33
+
34
+ Use headings for real reader tasks, not for every small fact. Keep heading
35
+ levels monotonic and avoid a deep hierarchy in root entrypoints. Lists are
36
+ useful for choices, requirements, and procedures; ordinary explanation should
37
+ remain prose rather than a stack of one-line bullets.
38
+
39
+ For Chinese, run a natural-language review after the facts and structure are
40
+ stable. Explain an unavoidable acronym on first use in each independently
41
+ readable document. Prefer direct verbs and concrete ownership over abstract
42
+ claims or slogan-like conclusions.
43
+
44
+ ## Decide whether a diagram helps
45
+
46
+ A diagram is useful for at least three dependent steps, three or more branches,
47
+ layer ownership, or relationships that are hard to reconstruct from prose. Use
48
+ the smallest fitting form: flowchart for sequence or decisions, hierarchy for
49
+ ownership, and table for repeated exact mappings.
50
+
51
+ Do not add a diagram for a single command, a short list, or decoration. Root
52
+ quick-start pages should normally stay linear. Architecture and contribution
53
+ guides are better candidates because their readers compare layers, lifecycle
54
+ states, or alternative extension paths.
55
+
56
+ Prefer Mermaid in Markdown repositories that render it. Place a one- or
57
+ two-sentence reading cue immediately before the diagram. Keep labels short,
58
+ define acronyms outside the diagram, and avoid colors or styling that depend on
59
+ one theme.
60
+
61
+ The diagram must not be the only home of a safety rule, command, protocol
62
+ constant, or evidence qualification. Nearby prose owns those facts. At the same
63
+ time, do not duplicate every node as a numbered list; summarize the governing
64
+ constraint and let the diagram carry the relationship.
65
+
66
+ ## Review and automate
67
+
68
+ Check heading hierarchy, prerequisite order, paragraph length, local links,
69
+ code-fence balance, and whether every diagram has an introduction and a clear
70
+ job. Render Mermaid when a renderer is already available; do not add a large
71
+ toolchain solely for a small documentation edit.
72
+
73
+ Repository tests may lock stable document roles, required destinations, and
74
+ project-specific section order. Avoid generic tests that freeze exact prose.
75
+ Tests should catch navigation drift, missing board coverage, broken links,
76
+ oversized paragraphs, duplicated volatile facts, or diagrams spreading into a
77
+ quick-start without a documented reason.