@lotics/cli 0.315.13 → 0.315.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/dist/src/cli.js +1939 -1934
- package/docs/knowledge_docs.md +22 -2
- package/package.json +1 -1
package/docs/knowledge_docs.md
CHANGED
|
@@ -152,8 +152,9 @@ Retrieval addresses **lines**. Every rule below follows from that one fact.
|
|
|
152
152
|
40 and its exception on line 90 can be retrieved apart. Use `context_lines` when reading, and
|
|
153
153
|
keep related clauses adjacent when writing.
|
|
154
154
|
|
|
155
|
-
Markdown headings are ordinary text — useful for a human
|
|
156
|
-
|
|
155
|
+
Markdown headings are ordinary text — useful for a human (a doc's `##` headings outside its
|
|
156
|
+
blocks, two or more, are listed on its page as its sections) and for orienting a
|
|
157
|
+
`read_knowledge`, but they carry no retrieval weight of their own.
|
|
157
158
|
|
|
158
159
|
**The description is the discovery hint.** It is what the agent sees in the tree before it has
|
|
159
160
|
read a byte of the body, so it is the only clue for *what term to grep for*. Write it to name
|
|
@@ -214,6 +215,25 @@ statement about discovery, so it cannot silently break an app that depends on a
|
|
|
214
215
|
Reach for it instead of `rm` whenever the material still matters: last year's tariff schedule, a
|
|
215
216
|
handbook a newer one replaced, the raw source a curated doc was written from.
|
|
216
217
|
|
|
218
|
+
## Formatting — what a doc draws
|
|
219
|
+
|
|
220
|
+
A doc is markdown with GFM tables. Beyond that it draws a few blocks, each in syntax you already write; the platform draws them in its own style, so every doc looks alike.
|
|
221
|
+
|
|
222
|
+
| Write | Draws |
|
|
223
|
+
|---|---|
|
|
224
|
+
| `> [!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]` or `[!CAUTION]` opening a blockquote | a callout in that tone |
|
|
225
|
+
| `<Note>`, `<Info>`, `<Tip>`, `<Check>`, `<Warning>`, `<Danger>` | the same callouts |
|
|
226
|
+
| a ```mermaid fence | a diagram: flowchart, sequence, timeline, gantt, `pie`, `xychart-beta`, `quadrantChart` (a 2x2; quadrant-1, top right, is drawn as the target), in the platform's theme; a flowchart's or a 2x2's own colour statements are dropped |
|
|
227
|
+
| `<Steps>` holding `<Step title="…">` | a numbered walk |
|
|
228
|
+
| `<Tabs>` holding `<Tab title="…">` | switchable panels |
|
|
229
|
+
| `<Columns cols={2}>` (or `<CardGroup>`) holding `<Card title="…" href="…" icon="…">` | side-by-side cards that stack on a phone; `icon` is a glyph from the model reference (a select option's mark), and a name it lacks is refused with the nearest |
|
|
230
|
+
| a table whose header cells are all empty | a table with no header row (a key/value table) |
|
|
231
|
+
| `<Accordion title="…">`, `<AccordionGroup>`, or `<details>` with a one-line `<summary>…</summary>` | a section that opens on press |
|
|
232
|
+
|
|
233
|
+
Each tag stands on a line of its own, and a tag line inside a fenced code block is code. Attributes are text in double quotes or a number in braces; nothing in a tag runs. A write that adds a tag that does not close, nests wrongly, carries an attribute the tag does not take, or names a component this list lacks (`<Frame>`, `<CodeGroup>`) is refused with the lines to fix; lowercase HTML (`<br>`) stays text.
|
|
234
|
+
|
|
235
|
+
A chart's numbers live in its mermaid source, which agents read and grep like any text: write them there once, not again in a table.
|
|
236
|
+
|
|
217
237
|
## Reaching the tools
|
|
218
238
|
|
|
219
239
|
```bash
|