docs(skill): teach gpustack-operator-docs the prose tells of AI writing - #701
Merged
Merged
Conversation
Add a Prose tells section to the docs conventions, adapted from the humanizer skill, and a checklist line so a docs diff is read for them before it ships. Signed-off-by: thxCode <thxcode0824@gmail.com>
|
✅ OpenCodeReview: Review skipped: no items were selected. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds a "Prose tells" section to the
gpustack-operator-docsskill'sreferences/conventions.md, adapted from the MIT-licensed humanizer skill. It lists the autopilot patterns to remove from docs prose (not-X-but-Y contrasts, one-line closers, forced triads, dashes as connectors, stock AI words, bold labels, and so on), the plain replacement for each, and three limits: keep every fact, change prose only, and treat a pattern as a default rather than a rule.SKILL.mdgains one checklist line and one clause pointing at it, becausecheck-docs.shcannot read prose.make lint docspasses.Which issue(s) this PR links to:
None.
Special notes for your reviewer:
Only the skill changes; no page under
docs/is rewritten here. The section exempts the template separators (header block, footer, table cells), code, pinned table rows and heading words, so the existing pages stay valid.Does this PR introduce a user-facing change?