Skip to content

[UIK-5348][docs] Create content section structure#3024

Draft
j-mnizhek wants to merge 8 commits into
release/v17from
UIK-5348/create-content-section-structure
Draft

[UIK-5348][docs] Create content section structure#3024
j-mnizhek wants to merge 8 commits into
release/v17from
UIK-5348/create-content-section-structure

Conversation

@j-mnizhek

@j-mnizhek j-mnizhek commented Jun 24, 2026

Copy link
Copy Markdown
Member

Motivation and Context

We need a single source of truth for UI copy guidelines. To achieve that, we're:

  • Expanding the Foundation / Content section.
  • Moving all shareable copy guidance and recommendations there.

Additionally, I added an exeption for vale (🐶) for the Content section, so it won't comment the bad examples 😁

Open question

Where would this section work best?

  • Inside Foundation
Screenshot 2026-06-24 at 15 18 36

or

  • As a separate top-level section next to Foundation
Screenshot 2026-06-24 at 15 17 21

How has this been tested?

Manually.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Nice improve.

Comment thread website/docs/content/buttons/buttons.md
Comment thread website/docs/content/content-principles/content-principles.md
Comment thread website/docs/content/content-principles/content-principles.md
Comment thread website/docs/content/content-principles/content-principles.md
Comment thread website/docs/content/content-principles/content-principles.md
Comment thread website/docs/content/pricing-and-sales/pricing-and-sales.md
Comment thread website/docs/content/system-states/system-states.md
Comment thread website/docs/content/system-states/system-states.md
Comment thread website/docs/content/voice-and-style/voice-and-style.md
Comment thread website/docs/content/voice-and-style/voice-and-style.md
@j-mnizhek j-mnizhek requested a review from sheila-semrush June 24, 2026 13:52
Comment thread website/docs/content/pricing-and-sales/pricing-and-sales.md
@j-mnizhek j-mnizhek requested a review from ana-sorokina June 24, 2026 16:40
Comment thread website/docs/.vitepress/theme/DosDonts.vue Outdated
Comment thread website/docs/.vitepress/theme/DosDonts.vue
Comment thread website/docs/.vitepress/theme/style.css Outdated
Comment thread website/docs/.vitepress/theme/DosDonts.vue Outdated
Comment thread website/docs/.vitepress/theme/DosDonts.vue Outdated

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.

I like the second version, with the separate 1st level section, but then I think we need to rename the "UX patterns", and maybe "UI elements", sub-sections because otherwise they will be constantly confused with our own components and patterns sections. Also, as there's not much in UX patterns and UI elements, maybe we can merge them for the time being?

Comment thread website/docs/content/pricing-and-sales/pricing-and-sales.md

@j-mnizhek j-mnizhek left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated docs and added comments for Nastya

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