Skip to content

refactor:Docs Structure and Navigation System#61

Merged
naymurdev merged 5 commits intoui-layouts:mainfrom
Yeom-JinHo:refactor/docs.ts
Sep 24, 2025
Merged

refactor:Docs Structure and Navigation System#61
naymurdev merged 5 commits intoui-layouts:mainfrom
Yeom-JinHo:refactor/docs.ts

Conversation

@Yeom-JinHo
Copy link
Contributor

#59

Description

This PR focuses on restructuring the documentation system and standardizing component categorization.
The main goal is to improve maintainability and consistency across the docs navigation and component organization.

Changes

  • Navigation Structure (major refactor): Restructured DocsNavigationCategories and mapped keys to AllComponents category keys for consistent navigation.
  • Component Categories (breaking change): Standardized component categories using DOCS_CATEGORY constants instead of hardcoded strings.
  • Configuration Cleanup: Simplified docs configuration structure and improved type definitions for better maintainability.
  • Type Safety: Enhanced type definitions for better TypeScript support and developer experience.

Motivation

  • Consistency: Unify navigation keys between DocsNavigationCategories and AllComponents to prevent mismatches.
  • Maintainability: Replace hardcoded category strings with constants to reduce duplication and improve maintainability.
  • Developer Experience: Improve type safety and simplify the docs configuration structure.
  • Code Quality: Remove redundant code and optimize component structure for better performance.

Breaking Changes

  • Category Constants: Component categories now use DOCS_CATEGORY constants instead of hardcoded strings.
    → Any code referencing hardcoded category strings will need to be updated to use the new constants.
  • Navigation Keys: Navigation structure has been restructured to ensure consistent key mapping.
    → Components relying on the old navigation structure may need updates.

@naymurdev
Copy link
Collaborator

@Yeom-JinHo thanks for all of your PR, I'll review it and merge but currently travelling a lot, so whenever i get in my desk, I'll do it

@naymurdev naymurdev merged commit b9eed0e into ui-layouts:main Sep 24, 2025
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.

2 participants