Skip to content

Commit 6410c87

Browse files
committed
Add instruction to avoid excessive irrelevant analogies
1 parent 03b1037 commit 6410c87

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

.agents/skills/write-mkdocs-documentation/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -568,6 +568,7 @@ Each major section should have an `index.md` that:
568568
- **Present tense:** "The module subscribes to..." not "The module will subscribe to..."
569569
- **Second person:** "You can configure..." not "One can configure..."
570570
- **Imperative for instructions:** "Install the package" not "You should install the package"
571+
- **No unnecessary analogies:** Avoid analogies that don't add technical clarity. Explain things directly as they are rather than comparing them to unrelated concepts.
571572

572573
### Be Specific
573574

docs/development/beginner/key_concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ graph LR
4848

4949
## How AirStack is Composed
5050

51-
Think of AirStack as a set of **Lego blocks** that snap together through Docker Compose:
51+
AirStack simulates multiple separate machines (e.g. robots, GCS) that communicate with each other through Docker Compose:
5252

5353
```mermaid
5454
graph TD

0 commit comments

Comments
 (0)