Skip to content

docs: update link section of style guide - #158

Merged
medubelko merged 2 commits into
canonical:mainfrom
medubelko:docs-style-guide-links
Jul 14, 2026
Merged

docs: update link section of style guide#158
medubelko merged 2 commits into
canonical:mainfrom
medubelko:docs-style-guide-links

Conversation

@medubelko

Copy link
Copy Markdown
Contributor
  • Reflow the section so it's more structured.
  • Make WCAG Success Criterion 2.4.4 the prescribed pattern.

Copilot AI review requested due to automatic review settings July 2, 2026 23:55
@medubelko
medubelko requested review from a team and lengau as code owners July 2, 2026 23:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR restructures the “Links” guidance in the Starcraft style guide to be more direct and prescriptive, with an accessibility-driven recommendation for link placement and updated examples.

Changes:

  • Rewrote the “Links” section into a clearer stepwise set of considerations (context → benefit → accessibility guidance).
  • Updated the “Good links” section heading and refined an example to better fit the recommended pattern.
  • Added a new “Bad links” section with concrete anti-pattern examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/how-to/starcraft-style-guide.rst
Comment thread docs/how-to/starcraft-style-guide.rst Outdated
Comment thread docs/how-to/starcraft-style-guide.rst Outdated
- Reflow the section so it's more structured.
- Make WCAG Success Criterion 2.4.4 the prescribed pattern.
@medubelko
medubelko force-pushed the docs-style-guide-links branch from 5025c8b to df3428e Compare July 3, 2026 00:00
@medubelko
medubelko merged commit 010c22c into canonical:main Jul 14, 2026
14 of 29 checks passed
@medubelko
medubelko deleted the docs-style-guide-links branch July 14, 2026 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants