Skip to content

Conversation

@eshanrnh
Copy link
Contributor

@eshanrnh eshanrnh commented Aug 26, 2025

📋 Description

  • Updated some rules to exclude inline code, URL.
  • Added frequently used acronyms to the exception list and the full form of all acronyms. Some are missing because I'm not sure what they are. We can take it off if it doesn't make sense 🤔
  • Added Repetition rule to catch repeated words.
  • Added link text rule to check for certain alt text used in Links, for example, here, read more.
  • Added description to all rules mentioning the goal/purpose of the rule.

📎 Related Issues (if applicable)

NA

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (“we”, “I”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

Deadline (if relevant)

Anytime

📚 Helpful Resources

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these changes look really great!
I'll be testing them out a bit tomorrow.

I'm really (probably a bit too much) excited about adding the "extensions" that ensure we can still write names with small caps when they're part of links etc.
Also the new rule about the link texts 🙏 That's a really great addition.

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested the rules locally and they work great!

I couldn't, however, I had to make some changes ot the "LinkTextClarity" rule to get it working. See my comment in the file.

Co-authored-by: sofietoft <stk@umbraco.com>
Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look great! 👏

@eshanrnh eshanrnh merged commit 26d87ce into main Aug 27, 2025
7 checks passed
@eshanrnh eshanrnh deleted the styleguide-rules branch August 29, 2025 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants