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

chore(docs): remove naming inconsistencies #5057

Merged
merged 3 commits into from
Jun 13, 2024
Merged

Conversation

zhpenkov
Copy link
Contributor

@zhpenkov zhpenkov commented May 31, 2024

related to: https://github.com/telerik/kendo-themes-private/issues/195

Summary:
Title across our .md file docs is generated by capitalizing the value of a group.

Example:
When the group value is:

/// @group floating-label

The component title will be:

# Customizing Floating-label

Some component's generated title is inconsistent with the proper naming of the component ( FloatingLabel ).

Solution:
We use a hyphen for separating individual words from the compound words for the group values ( example above ).
We can utilize the hyphen to create a title based on each capitalized individual word that makes up the compound word.
( kebab case to pascal case )

List of variable groups that have been updated as well:

  • coloreditor -> color-editor
  • colorgradient -> color-gradient
  • colorpalette -> color-palette
  • filemanager -> file-manager
  • tilelayout -> tile-layout

@zhpenkov zhpenkov added the Documentation Improvements or additions to documentation label May 31, 2024
@zhpenkov zhpenkov self-assigned this May 31, 2024
@zhpenkov zhpenkov marked this pull request as ready for review June 7, 2024 13:44
@zhpenkov zhpenkov requested a review from a team as a code owner June 7, 2024 13:44
Copy link
Contributor

@Juveniel Juveniel left a comment

Choose a reason for hiding this comment

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

lgtm; change commit to docs: ...

@Juveniel Juveniel added this to the 2024 Q3 (Aug) milestone Jun 12, 2024
@zhpenkov zhpenkov merged commit fea2fd9 into develop Jun 13, 2024
29 checks passed
@zhpenkov zhpenkov deleted the fix-naming-inconsistency branch June 13, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants