UA Text Review and Updated Docs Style Guide#169
Merged
Conversation
🔗 Link Check ResultsThe link checker has completed. This is an optional check and will not block the PR. If broken links were found, please review them at your convenience. Last updated: Run #243 at 2026-06-09T08:49:36Z |
Member
|
Thank you very much @lfindlaysap |
longieirl
added a commit
that referenced
this pull request
Jul 6, 2026
Add new rules from UA Text Review (PR #169) that were missing: structural.js: - Prerequisites bullets must start with "You have" or "You are" - License heading must be H2 - Headings must not end with colon or question mark - "Step N:" and "Issue N:" heading prefixes are banned - Discouraged heading names flagged (Get Support -> Help and Support, etc.) formatting.js: - Title case now applies to all heading depths (not just H1/H2) - toTitleCase updated: "with" added to lowercase prepositions; participles ("Using", "Running") now correctly capitalized as verbs/adjectives - shouldUseTitleCase applies to all headings (not a keyword subset) content.js: - Semicolons in prose flagged (replace with colon or period) - Single-item ordered lists flagged (convert to bullet or prose) - "There are N / the following N" list count in prose flagged AGENTS.md: - Documentation standards section updated to reflect all PR #169 rules Co-Authored-By: Claude <noreply@anthropic.com>
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
2 participants
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.
Pull Request
Updates all the
.mdand other text files in accordance with the UI text writing guidelines and SAP Style Guide for Technical Communication. Updated the style guide and skill accordingly.Checklist