1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00

5 Commits

Author SHA1 Message Date
David Karlsson
bb68010daa docs: clarify technical writing guidance
Technical explanations can be accurate while leaving readers to reconstruct outcomes or act on open-ended caveats. Document outcome-first prose, product boundaries, actionable variability, precise actors, meaningful qualifiers, and proportional caveats.
2026-07-20 11:59:05 +00:00
Brandon Hunt
3a54daf566 docs: use consistent file+anchor link style for Images reference 2026-07-06 16:13:59 -06:00
Brandon Hunt
fd121c057e docs: add explicit single-page guide structure callout 2026-07-06 14:10:06 -06:00
David Karlsson
20a3d5a774 Fix bot review false positives: drop fabricated 80-char rule, clarify enable/disable
The PR-review bot's prompt instructed it to flag lines over 80 characters,
but no such rule exists in the repo (markdownlint MD013 is disabled and
STYLE.md never mentions it). Remove that instruction from pr-review.yml.

Also clarify the STYLE.md word list so "turn on/off" applies to UI toggles
while "enable/disable" stays acceptable in general prose, matching STYLE.md's
own example. This stops the bot from flagging every "enable" as a violation.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-02 12:36:47 +02:00
David Karlsson
9f380d429e chore: refactor style guide to STYLE.md and COMPONENTS.md
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-05 10:38:35 +01:00