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

Docs Redesign #332

Merged
merged 153 commits into from
Jun 10, 2024
Merged

Docs Redesign #332

merged 153 commits into from
Jun 10, 2024

Conversation

Mfigueira
Copy link
Member

@Mfigueira Mfigueira commented May 24, 2024

Update all Docs structure and styles with new design

  • Add new Layout with left menu drawer, simplified header and footer
  • Add Hero component, configurable with frontMatter
  • Add new navigation system, with NavigationSections and NavigationCardLinks for main/index pages
  • Add new prev and next articles navigation
  • Add title, description, readTime, and readType _meta.json info to docs pages that will be displayed in the navigation cards (ToDo: add more of these to all relevant pages)
  • Add a variety of new icons and illustrations
  • Add new main pages with updated components and content (Home, About, Support, Community)
  • Restructure some docs directories to align better with new designs
  • Add new responsive styles for all screen widths
  • Fix minor issues and nits from Nextra migration
  • Add custom rendered components for mdx content and new Article template layout

Copy link
Collaborator

@GMaiolo GMaiolo left a comment

Choose a reason for hiding this comment

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

Concept ACK
🚀

@fadeev
Copy link
Member

fadeev commented Jun 6, 2024

When clicking on "Continue Learning" box it doesn't scroll to the top of the page.

@fadeev
Copy link
Member

fadeev commented Jun 6, 2024

The TOC sidebar on the right no longer works.

@vercel vercel bot temporarily deployed to Preview – docs June 7, 2024 23:49 Inactive
@fadeev
Copy link
Member

fadeev commented Jun 8, 2024

Screenshot 2024-06-08 at 12 39 02

I've noticed that this components intelligently fetches the nested pages, but one thing it skips is index pages. Which I thought was a small bug, but then I realized we could keep it as a feature and call pages index when we want to skip them and name them differently when we want them bubble up to the top.

@vercel vercel bot temporarily deployed to Preview – docs June 8, 2024 14:10 Inactive
@vercel vercel bot temporarily deployed to Preview – docs June 8, 2024 14:18 Inactive
@vercel vercel bot temporarily deployed to Preview – docs June 10, 2024 07:37 Inactive
@fadeev fadeev merged commit 9a7480d into main Jun 10, 2024
6 checks passed
@fadeev fadeev deleted the docs-redesign branch June 10, 2024 08:00
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