Revamp documentation page for improved readability and visuals#802
Open
dhananjay6561 wants to merge 2 commits intokeploy:mainfrom
Open
Revamp documentation page for improved readability and visuals#802dhananjay6561 wants to merge 2 commits intokeploy:mainfrom
dhananjay6561 wants to merge 2 commits intokeploy:mainfrom
Conversation
Signed-off-by: dhananjay6561 <dhananjayaggarwal6561@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR revamps the Docusaurus docs UI (layout, typography, sidebar/TOC, dark mode styling) to improve readability and navigation across breakpoints.
Changes:
- Applies a new visual system (DM Sans typography, updated spacing, refreshed sidebar/TOC styling).
- Improves dark-mode styling for tier chips/callouts and code/inline-code presentation.
- Adjusts TOC configuration globally (min/max heading levels) and per-doc metadata.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/css/custom.css |
Global typography enforcement, code/TOC/sidebar/pagination styling refinements, dark-mode adjustments. |
src/theme/DocItem/styles.module.css |
Adds DocItem-level styling overrides (layout/sidebar/TOC/typography). |
src/theme/Heading/styles.module.css |
Removes visible # marker from heading anchor links. |
src/components/ProductTier.js |
Updates dark-mode chip appearance. |
src/components/TierCallout.js |
Improves dark-mode note/chip contrast. |
docusaurus.config.js |
Sets global TOC heading-level configuration. |
docs/gsoc/contribution-guide.md |
Adds TOC front-matter configuration for the page. |
src/theme/DocItem/index.js |
Minor formatting change; DocItem/TOC rendering remains the same. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs Page Revamp – Visual & UX Improvements
Overview
This PR delivers a comprehensive visual and UX revamp of the documentation site with a focus on:
Key Changes
Visual Overhaul
src/theme/DocItem/styles.module.cssfor a cleaner documentation experienceResponsiveness
Dark Mode Enhancements
ProductTier.jsTierCallout.jsTOC Improvements
docusaurus.config.jsMiscellaneous
src/theme/Heading/styles.module.css)docs/gsoc/contribution-guide.mdFiles Changed
src/css/custom.csssrc/theme/DocItem/styles.module.csssrc/theme/Heading/styles.module.csssrc/components/ProductTier.jssrc/components/TierCallout.jsdocusaurus.config.jsdocs/gsoc/contribution-guide.mdsrc/theme/DocItem/index.jsTotal: 603 additions, 264 deletions
Screenshots
Desktop Responsiveness
Before vs After
Tablet View
Before vs After
Mobile View
Before vs After
Dark Mode
Before vs After
Build Verification
Successful production build