Skip to content

Commit fecce6a

Browse files
committed
Keep JSON notes short
At most three short notes with only what a user must know or do, and a one- or two-sentence description of the app.
1 parent 367a7b1 commit fecce6a

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

‎.github/agents/pve-script-creator.agent.md‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎AGENTS.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1676,6 +1676,13 @@ produces a generated command that looks right and changes nothing.
16761676
16771677
**Note types:** `info`, `warning`, `error`
16781678
1679+
**Keep notes short.** The script page shows every note; a wall of text gets skipped.
1680+
1681+
- At most 3 notes, one or two short sentences each (about 200 characters).
1682+
- Only what a user has to know or do: how to get the first login, a required manual step (API key, reverse proxy, HTTPS), a real risk (open signup, no auth).
1683+
- Leave out what the script installs, build times, RAM measurements, update mechanics, upstream bugs, data paths the user never has to touch, and anything the description or the CT script's final message already says.
1684+
- `description` describes the app in 1–2 sentences (about 300 characters), not the script.
1685+
16791686
### Examples with Credentials
16801687
16811688
```json

0 commit comments

Comments
 (0)