Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
👋 Codeowner Review RequestThe following codeowners have been identified for the changed files: Team reviewers: @nodejs/nodejs-website Please review the changes when you have a chance. Thank you! 🙏 |
There was a problem hiding this comment.
Pull request overview
This pull request removes the MetaBar component to give the main content more space on the website. The MetaBar functionality (showing metadata like last updated date, reading time, authors, and table of contents) has been migrated to the Sidebar component and a new collapsible TableOfContents component.
Changes:
- Removed the MetaBar component and all related files (component, tests, stories, CSS)
- Migrated metadata display to the Sidebar component
- Added a new WithTOC component that uses TableOfContents for displaying headings
- Consolidated multiple layout components (Learn, About, ArticlePage) into a single DefaultLayout with configuration options
- Updated the Article layout CSS to support the new two-column layout instead of three-column
- Updated i18n translations to move metabar keys to sidebar namespace
- Version bump from 1.5.8 to 1.6.0
Reviewed changes
Copilot reviewed 21 out of 22 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
packages/ui-components/src/Containers/MetaBar/index.tsx |
Removed entire MetaBar component |
packages/ui-components/src/Containers/MetaBar/index.stories.tsx |
Removed MetaBar storybook stories |
packages/ui-components/src/Containers/MetaBar/__tests__/index.test.jsx |
Removed MetaBar tests |
packages/ui-components/src/Containers/MetaBar/index.module.css |
Removed MetaBar CSS styles |
apps/site/components/withMetaBar.tsx |
Removed withMetaBar wrapper component |
packages/ui-components/src/Containers/Sidebar/index.tsx |
Added Separator import and conditional rendering |
packages/ui-components/src/Containers/Sidebar/index.module.css |
Added dl/dt/dd styles migrated from MetaBar |
apps/site/components/withSidebar.tsx |
Added metadata display logic (date, reading time, authors, contribute link) |
apps/site/components/withTOC.tsx |
New component for rendering table of contents |
packages/ui-components/src/Containers/Article/index.module.css |
Updated grid layout from 3-column to 2-column |
packages/ui-components/src/Common/TableOfContents/index.module.css |
Removed lg:hidden to show TOC on all screen sizes, added sticky positioning |
packages/ui-components/src/Common/Preview/index.module.css |
Added max-width constraint |
apps/site/layouts/Default.tsx |
Enhanced to support breadcrumbs and navigation keys, added AboutPageLayout and LearnPageLayout exports |
apps/site/layouts/Post.tsx |
Simplified to use DefaultLayout |
apps/site/layouts/Learn.tsx |
Removed (functionality moved to DefaultLayout) |
apps/site/layouts/About.tsx |
Removed (functionality moved to DefaultLayout) |
apps/site/layouts/ArticlePage.tsx |
Removed (functionality moved to DefaultLayout) |
apps/site/layouts/layouts.module.css |
Removed contentLayout and postLayout styles, added postAuthors style |
apps/site/components/withLayout.tsx |
Updated layout mappings to use new layout exports |
packages/i18n/src/locales/en.json |
Moved metabar translations to sidebar namespace, added onThisPage key |
packages/ui-components/package.json |
Version bump to 1.6.0 |
apps/site/next-env.d.ts |
Updated Next.js types path |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
📦 Build Size ComparisonSummary
Changes➕ Added Assets (9)
➖ Removed Assets (9)
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8596 +/- ##
=======================================
Coverage 75.03% 75.04%
=======================================
Files 103 102 -1
Lines 9062 8989 -73
Branches 312 309 -3
=======================================
- Hits 6800 6746 -54
+ Misses 2260 2241 -19
Partials 2 2 ☔ View full report in Codecov by Sentry. |
ovflowd
left a comment
There was a problem hiding this comment.
This is huge change on the overall design of the webiste... That I don't think should simply drop in like a PR.
I'm unfortunately also not a fan at all of these design choices, sorry. Not sure what you're trying to solve with removing the MetaBar.
This PR removes the
MetaBarin order to give the main content more space on the website.While collecting feedback for
doc-kit, many people noted that the main content is simply too narrow.This, obviously, isn't the only solution to that problem, and it's worth noting that many sites use a "three column system", so this may go against the norm.
Alternatively, we could update the paddings to give the next column much more space.
After:
