Skip to content
This repository has been archived by the owner on Jan 23, 2024. It is now read-only.

docs(structure): rework docs structure #353

Merged
merged 37 commits into from
Mar 4, 2022
Merged

Conversation

nikolovlazar
Copy link
Contributor

📝 Description

The main feature branch for the docs structure rework. Previously two PRs were merged into this branch: #301 and #323.

🚀 New behavior

The docsite's content is restructured. The content is split into two categories: Styled System and Components. Two new pages were introduced: Styled System Overview and Components Overview. All URLs are changed accordingly, and proper redirects are put in place to ensure links shared on social media still work. All work done by @noobinthisgame ⭐️

💣 Is this a breaking change (Yes/No):

No

noobinthisgame and others added 30 commits February 11, 2022 00:35
…akra-ui-docs into feat/api_components_overview_pages
…akra-ui-docs into feat/api_components_overview_pages
feat: rework docs structure and improve discoverability
…akra-ui-docs into feat/api_components_overview_pages
…iew_pages

feat: add overview pages for components and styled-system
@nikolovlazar nikolovlazar added documentation Improvements or additions to documentation created-by: Chakra UI team Created by a Chakra UI core team member labels Feb 24, 2022
@vercel
Copy link

vercel bot commented Feb 24, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/chakra-ui/chakra-ui-docs/J8cB3gGxfQ8X7YQeDMZBJf2a5zno
✅ Preview: https://chakra-ui-docs-git-docs-rework-docs-structure-chakra-ui.vercel.app

Copy link
Contributor

@jacobhq jacobhq left a comment

Choose a reason for hiding this comment

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

Maybe put the hooks into a separate section, or to the components section

@noobinthisgame
Copy link
Collaborator

Thanks @jacobhq for the feedback. As the hooks are beeing used under the hood to provide logic and theming to the components I don't think they should be placed in the components section. This one just regroups ready to use components. Further the hooks are part of the Chakra UI API which leads me to think they are well kept in the styled-system section that regroups feature and API documentation. Maybe in the future once there is more hooks it can make sense to split them up in their own section.

@jacobhq
Copy link
Contributor

jacobhq commented Feb 28, 2022

That makes sense, thank you!

…-issues

fix: menu mobile UI spacing issues
@nikolovlazar nikolovlazar merged commit db412ff into main Mar 4, 2022
@nikolovlazar nikolovlazar deleted the docs/rework-docs-structure branch March 4, 2022 07:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
created-by: Chakra UI team Created by a Chakra UI core team member documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants