Skip to content

refactor: enhance documentation navigation and modernize i18n structure - #2252

Merged
bjohansebas merged 16 commits into
expressjs:redesignfrom
ShubhamOulkar:refactor
Apr 3, 2026
Merged

refactor: enhance documentation navigation and modernize i18n structure#2252
bjohansebas merged 16 commits into
expressjs:redesignfrom
ShubhamOulkar:refactor

Conversation

@ShubhamOulkar

@ShubhamOulkarShubhamOulkar commented Apr 2, 2026

Copy link
Copy Markdown
Member
  1. Refactored Breadcrumb component
  2. Implemented content aware linking in buildBreadcrumbs (unlinked for docs, linked for API/Blog/Resources). ref
  3. Abstracted documentation navigation logic from DocLayout.astro into DocBottomNav.
  4. Improved PageTopbar responsiveness with a vertical stack layout on small screens.
  5. Standardized aria-label across all navigation components for better accessibility.
  6. Updated and reorganized all 10 UI translation JSON files to a nested schema.

@ShubhamOulkar
ShubhamOulkar requested a review from a team as a code ownerApril 2, 2026 12:50
@netlify

netlifyBot commented Apr 2, 2026

Copy link
Copy Markdown

Deploy Preview for expressjscom-preview ready!

NameLink
🔨 Latest commit48a3ed9
🔍 Latest deploy loghttps://app.netlify.com/projects/expressjscom-preview/deploys/69cf1e6f269a41000840a3dc
😎 Deploy Previewhttps://deploy-preview-2252--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🟢 up 3 from production)
Accessibility: 100 (🟢 up 13 from production)
Best Practices: 100 (no change from production)
SEO: 100 (🟢 up 6 from production)
PWA: 80 (🟢 up 50 from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@ShubhamOulkar
ShubhamOulkar marked this pull request as draft April 2, 2026 12:50
@ShubhamOulkar
ShubhamOulkar removed the request for review from a teamApril 2, 2026 12:54
@ShubhamOulkarShubhamOulkar changed the title WIPrefactor: Enhance Documentation Navigation and Modernize i18n StructureApr 2, 2026
@ShubhamOulkarShubhamOulkar changed the title refactor: Enhance Documentation Navigation and Modernize i18n Structurerefactor: enhance documentation navigation and modernize i18n structureApr 2, 2026
@ShubhamOulkarShubhamOulkar self-assigned this Apr 2, 2026
@ShubhamOulkar
ShubhamOulkar marked this pull request as ready for review April 3, 2026 00:29
@bjohansebas

Copy link
Copy Markdown
Member

Okay, I’ll review it right away, because after that I’ll start working on Crowdin

@ShubhamOulkar

Copy link
Copy Markdown
MemberAuthor

@bjohansebas fixing heading I will push in changes

@bjohansebas

Copy link
Copy Markdown
Member

Why is it returning the #? It wants them because they’re already being generated from the layout—it’s intentional

items: [
{ href: '/api/middleware/basicauth', label: 'basicAuth()' },
{ href: '/api/middleware/bodyparser', label: 'bodyParser()' },
{ href: '/api/middleware/compress', label: 'compress()' },

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am confused here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Express 3 included middlewares; Express 4 removed them. We can’t remove them because they’re part of the 3.x API.

@ShubhamOulkar

Copy link
Copy Markdown
MemberAuthor

Why is it returning the #? It wants them because they’re already being generated from the layout—it’s intentional

Api pages were rendering two h1 headings, so I decided to align docs with api pages and remove h1 from DocsLayout.

@bjohansebas

bjohansebas commented Apr 3, 2026

Copy link
Copy Markdown
Member

Api pages were rendering two h1 headings, so I decided to align docs with api pages and remove h1 from DocsLayout.

It’s the other way around—we should remove the #h1. It was intentional; I was planning to finish fixing that in another PR, but I didn’t get to it because I’m wrapping up some things in webpack.

@ShubhamOulkar

Copy link
Copy Markdown
MemberAuthor

I was planning to finish fixing that in another PR

OK, then you need to edit all API markdowns.

@bjohansebas

Copy link
Copy Markdown
Member

OK, then you need to edit all API markdowns.

yep, but in other pr, please

@ShubhamOulkar

ShubhamOulkar commented Apr 3, 2026

Copy link
Copy Markdown
MemberAuthor

OK, then you need to edit all API markdowns.

yep, but in other pr, please

But I dont understand why are you choosing more editing files over small docs files? At end we are rendering same headings as title. are you planning to change API headings? (property, methods)

@bjohansebasbjohansebas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Next PRs will be follow-ups to this, I’ll be working on Crowdin

@bjohansebas

Copy link
Copy Markdown
Member

Yes, I plan to improve how we present the API so that options and arguments are displayed more clearly—something similar to how it’s done in Node.js

@bjohansebas
bjohansebas merged commit b9b3b9c into expressjs:redesignApr 3, 2026
15 of 16 checks passed
@ShubhamOulkar
ShubhamOulkar deleted the refactor branch April 3, 2026 02:14
@ShubhamOulkar

Copy link
Copy Markdown
MemberAuthor

great 🤗 please let me know whenever changes happen. It will be great experience to review/polish documentations

@bjohansebasbjohansebas mentioned this pull request Apr 4, 2026
Sign up for freeto 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

@ShubhamOulkar@bjohansebas