Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UIK-2755][website] Headings and labels #1916

Merged
merged 18 commits into from
Jan 20, 2025

Conversation

j-mnizhek
Copy link
Contributor

@j-mnizhek j-mnizhek commented Jan 10, 2025

Motivation and Context

This PR introduces changes to the headings in our documentation to conform to the '2.4.6 Headings and Labels' criterion.

  1. Made small updates to the headings throughout the documentation to ensure greater consistency across documents.
  2. Changed the placement of some sections to make the document structure more consistent across the documentation.

I ignored a couple of suggestions from the vale since they are not applicable for some of the changes.

How has this been tested?

Manually.

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.

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly or it's not required.
  • Unit tests are not broken.
  • I have added changelog note to corresponding CHANGELOG.md file with planned publish date.
  • I have added new unit tests on added of fixed functionality.

@j-mnizhek j-mnizhek changed the title [UIK-2755][website] Headings labels [UIK-2755][website] Headings and labels Jan 10, 2025
@j-mnizhek
Copy link
Contributor Author

j-mnizhek commented Jan 14, 2025

Made two small updates based on our discussion on KB:

  1. Replaced Location with Placement heading everywhere
  2. Unified Types section. Themes sections are now included in Types section.

Also updated Pagination documentation for the other task to avoid conflicts in the structure.

@sheila-semrush
Copy link
Contributor

sheila-semrush commented Jan 15, 2025

@j-mnizhek added my own commit to avoid posting a bunch of suggestions, I've shortened some long 2nd level headings and unified example headings a bit, feel free to add or edit over it

@j-mnizhek
Copy link
Contributor Author

@j-mnizhek added my own commit to avoid posting a bunch of suggestions, I've shortened some long 2nd level headings and unified example headings a bit, feel free to add or edit over it

Decided to move all the things related to appearance under the Appearance section, so that in the future we wouldn’t have to think much when we should put sizes, types, and topics outside of it, and where we shouldn’t.

@j-mnizhek
Copy link
Contributor Author

@sheila-semrush Made small updates, added missed Appearance headings, fixed dead link (it's strange that only one was found).

@sheila-semrush sheila-semrush self-requested a review January 20, 2025 13:48
Copy link
Contributor

@sheila-semrush sheila-semrush left a comment

Choose a reason for hiding this comment

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

@j-mnizhek looks good to me!
You can also look at my last commit, I thought we need to fix the heading structure in our README/CONTRIBUTING files, so that the overall structure is correct when you view them on Github. Feel free to edit If you have any suggestions.

@Valeria-Zimnitskaya Valeria-Zimnitskaya merged commit 578060b into master Jan 20, 2025
9 checks passed
@Valeria-Zimnitskaya Valeria-Zimnitskaya deleted the UIK-2755/vpat/headings-labels branch January 20, 2025 14:55
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.

3 participants