Skip to content

Style guide update#7877

Merged
giorgionaps merged 5 commits intomainfrom
style-guide-update
Feb 11, 2026
Merged

Style guide update#7877
giorgionaps merged 5 commits intomainfrom
style-guide-update

Conversation

@giorgionaps
Copy link
Contributor

@giorgionaps giorgionaps commented Feb 9, 2026

Description

Closes #7785. Style guide updates. Updates to match what's been added to confluence earlier:

  • Added UI text to the style guide application scope
  • Aligned admonitions with Confluence rules (limited types + explicit avoid list)
  • Made section linking mandatory and aligned link behavior (deep links, /docs routing, new-tab external links, UI exception)
  • Added AP Style guidance for quotation marks
  • Clarified time zones and daylight savings, including range formatting
  • Updated titles and headers to require action-oriented wording and added the blog title casing exception
  • Added retroactive step reference rule to numerical lists
  • Added guidance for CLI commands and details elements
  • Added job title capitalization exceptions, including leadership lists

New additions:

  • Sub-section linking: in Grammar > Bolding and Implementation steps > Links, explicitly clarified that section references must be descriptive links rather than bold text.
  • Contractions: added a new row in Grammar > Contractions explicitly encouraging the use of common contractions for a natural, conversational tone.
  • Empowering language: in Grammar > Empowering language, specified using framing like "With , you’ll..." to focus on user outcomes.
  • Sub-process usage: in Product names and other terminology > BPMN sub-process terminology, clarified the requirement to use the hyphenated "sub-process" in user-facing prose.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@giorgionaps giorgionaps requested a review from a team February 9, 2026 12:15
@giorgionaps giorgionaps added the low prio There is no urgency with this change. label Feb 9, 2026
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Feb 9, 2026
@christinaausley
Copy link
Contributor

Semi-relates to #7465 (for my tracking purposes 😄)

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Thank you! 🥳

@giorgionaps giorgionaps merged commit 8ce62a2 into main Feb 11, 2026
17 checks passed
@giorgionaps giorgionaps deleted the style-guide-update branch February 11, 2026 14:41
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

low prio There is no urgency with this change.

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Clarify contractions usage in the style guide

2 participants

Comments