bearings 0.5.4 → 0.5.5

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bearings",
3
- "version": "0.5.4",
3
+ "version": "0.5.5",
4
4
  "description": "Give your AI agents their bearings — scaffold an agent-friendly setup in any repository.",
5
5
  "type": "module",
6
6
  "engines": {
@@ -35,6 +35,13 @@ authored instructions; the static previewer owns execution state.
35
35
 
36
36
  ## Content Policy
37
37
 
38
+ - **Show** every operator-facing field (`title`, `summary`, `intro`,
39
+ `callout`, `conventions`, section `intro`, `instruction`, `expectedResult`,
40
+ `warning`, `failureGuidance`, link `label`). The field is the action,
41
+ command, path, identifier, or observable. Lead with that object. Shortest
42
+ scannable structure: line, bullets, `codeBlocks`, exact value. Prose fields
43
+ render HTML (`<code>`, `<strong>`). Titles, chrome, and `codeBlocks` stay
44
+ plain text. ASD-STE100 Simplified Technical English for a reader with ADHD.
38
45
  - Organize sections in execution order and keep each checklist item to one
39
46
  primary action or verification. Use `info` sections for concise context that
40
47
  the operator does not mark as executed.
@@ -64,6 +71,7 @@ authored instructions; the static previewer owns execution state.
64
71
  ## Completion
65
72
 
66
73
  Finish only when exactly one authored checklist file exists for this request,
67
- its mechanics and outcomes trace to evidence, its validator prints `OK`, the
68
- full library build succeeds, and the static previewer opens or its absolute path
69
- is reported after an opening failure.
74
+ its mechanics and outcomes trace to evidence, every operator-facing field
75
+ leads with an action, command, path, identifier, or observable, its validator
76
+ prints `OK`, the full library build succeeds, and the static previewer opens
77
+ or its absolute path is reported after an opening failure.
@@ -35,6 +35,12 @@
35
35
  return node;
36
36
  }
37
37
 
38
+ function html(tag, className, markup) {
39
+ var node = element(tag, className);
40
+ if (markup !== undefined) node.innerHTML = markup;
41
+ return node;
42
+ }
43
+
38
44
  function setStatus(message, isError) {
39
45
  status.textContent = message;
40
46
  status.dataset.tone = isError ? 'error' : 'info';
@@ -331,7 +337,7 @@
331
337
 
332
338
  function textBlock(className, label, value) {
333
339
  var block = element('div', 'step-block ' + className);
334
- block.append(element('span', 'field-label', label), document.createTextNode(value));
340
+ block.append(element('span', 'field-label', label), html('div', '', value));
335
341
  return block;
336
342
  }
337
343
 
@@ -844,7 +850,7 @@
844
850
  var navigationList = element('ol', 'section-nav-list');
845
851
  navigation.append(navigationList);
846
852
  var checklistBody = element('div', 'checklist-body');
847
- if (checklist.intro) checklistBody.append(element('p', 'intro', checklist.intro));
853
+ if (checklist.intro) checklistBody.append(html('div', 'intro', checklist.intro));
848
854
  if (checklist.callout) checklistBody.append(textBlock('callout', 'Important', checklist.callout));
849
855
  if (checklist.conventions) checklistBody.append(textBlock('conventions', 'Conventions', checklist.conventions));
850
856
 
@@ -856,7 +862,7 @@
856
862
  var heading = element('div', 'section-heading');
857
863
  heading.append(element('span', 'section-number', section.number), element('h2', '', section.title));
858
864
  sectionElement.append(heading);
859
- if (section.intro) sectionElement.append(element('p', 'section-intro', section.intro));
865
+ if (section.intro) sectionElement.append(html('div', 'section-intro', section.intro));
860
866
  var items = element('div', 'items');
861
867
  section.items.forEach(function (item) { items.append(renderItem(item, section.kind, false, sectionIndex)); });
862
868
  sectionElement.append(items);