facebook / facebook/astryx

Agent-docs template: the dense-data and status-component rules feel out of place in the RULES block

Open
#4,171 0 comments 0 reactions 1 assignee Claimed by @josephfarina View on GitHub
Dominant language
TypeScript
Stars
13k
Forks
1.1k
Avg merge
1d 15h
Merged PRs (30d)
690

Description

In the v0.1.7 managed agent-docs block (`astryx init --features agents`), two of the new RULES lines feel out of place:

```
- Dense data = rows (Table, List/Item) edge-to-edge — never Card-wrapped list items. Card = dashboard widgets, galleries, settings groups only.
- Status → StatusDot/Token; Badge only for counts and enumerated states, never decoration.
```

The rest of the RULES block is mechanical and universally applicable — no raw divs, tokens for every value, self-check before finishing. These two are design-judgment heuristics about *which component to choose for a use case*. They read more like design-review guidance than setup rules, and in the RULES list they carry the same absolute weight ("never") as the mechanical invariants, which isn't obviously right for every product.

Worth considering:
- moving them to a separate section (e.g. COMPONENT CHOICE or DESIGN HEURISTICS) so agents can distinguish hard invariants from judgment calls, or
- relocating them into `astryx docs` topics / `astryx build` output where component-choice guidance already lives.

Filed while reviewing the 0.1.2 → 0.1.7 block diff in a consuming repo.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.