Open
Conversation
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
✅ Deploy Preview for expressjscom-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: shubham oulkar <91728992+ShubhamOulkar@users.noreply.github.com> Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com> Co-authored-by: Shubham Oulkar <oulkarshubhu@gmail.com>
Co-authored-by: shubham oulkar <91728992+ShubhamOulkar@users.noreply.github.com>
Co-authored-by: shubham oulkar <91728992+ShubhamOulkar@users.noreply.github.com>
Co-authored-by: shubham oulkar <91728992+ShubhamOulkar@users.noreply.github.com> Co-authored-by: Shubham Oulkar <oulkarshubhu@gmail.com> Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Co-authored-by: Shubham Oulkar <oulkarshubhu@gmail.com>
Co-authored-by: Shubham Oulkar <oulkarshubhu@gmail.com> Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Co-authored-by: Shubham Oulkar <oulkarshubhu@gmail.com> Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
| @@ -0,0 +1,72 @@ | |||
| import { visit, SKIP } from 'unist-util-visit'; | |||
Member
There was a problem hiding this comment.
<div class="table-scroller" markdown="1" />
<div class="table-scroller">
<table>Just to make a note some of the tables having table-scroller in markdown.
e.g. express.json() table
…) in Express 5 migration guide (#2211) Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
|
FYI orama logo is 404 |
Member
Author
the same thing happens in Node.js and Fastify as well. I’m already asking the Orama team where I can get those images to fix it. |
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
7 participants
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.
Preview Url :- https://deploy-preview-2169--expressjscom-preview.netlify.app/
Important
The conflicts will be resolved when we’re ready to release it to the public, so don’t worry about that—one of the captains will handle it when the time comes.
Overview
The design aims to closely follow the original Figma as much as possible. However, due to time constraints, it was not feasible to keep it fully up to date, as Orama supported the redesign effort until April 3.
Throughout the development process, feedback was continuously gathered via Slack, and adjustments were made iteratively as the site evolved.
As part of this transition, and to provide a clear before-and-after reference for the API content, the
gh-pagesbranch will be left untouched, while a newmainbranch has been introduced, which will become the default branch of the repository.The following sections outline the key decisions that were made and explain why certain aspects of the site are implemented the way they are.
For more in-depth details on how the site works, everything is documented in the repository under the
docsfolder.API Routes
At the beginning, each method and property had its own URL. Over time, we decided to group them by object (
req,res,app,router) to reduce both build times and page size.Previously, the site could reach up to 600MB due to all generated i18n pages. With this change, the build process is now significantly faster and more efficient.
Search
The original Figma proposal placed the search as a right-side panel. This was changed to a modal-based search, mainly because the original design didn’t account for having a Table of Contents (ToC) per page.
Important note:
This is the only part of the site that uses React. It was implemented following Orama’s recommendation to ensure a fast and high-quality search experience.
Menu
Compared to the Figma design, the language switcher and dark/light theme toggle were moved next to the search.
This follows a pattern similar to the Node.js website.
Versioning
The Figma design did not include page versioning. During development, we decided to introduce versioning for documentation pages.
How versioning works is documented in the repository under the
docsfolder.i18n
The versioning system remains intact.
Current issue:
For now:
Once fixed:
Footer
The original footer design did not follow the foundation’s recommendations.
It was updated to include the proper copyright text, which was later also added to the current expressjs.com site.
Updated Documentation
During this process, several parts of the documentation were improved:
Example:
https://deploy-preview-2169--expressjscom-preview.netlify.app/en/resources/middleware/body-parser/
More documentation will continue to be improved over time throughout the year with the team.
API Overview
The API now includes an overview section, improving organization and aligning with the new versioning system.
llms.txt
Support was added to generate
llms.txtfiles from the documentation.This allows language models to better access and understand the docs:
https://deploy-preview-2169--expressjscom-preview.netlify.app/llms.txt
OG Images
All pages now have dynamically generated Open Graph images.
Note:
Homepage Announcement Banner
The homepage banner is now automated:
This behavior is documented in the
docsfolder.CI: Broken Link Detection
Accessibility
Light Mode
Issues Resolved
The following issues were closed as part of this migration (and likely more):
Final Notes
Personal Note of Sebastian
Important
I’d really like to be the one to press the merge button.
The main reason I joined Express was to improve the documentation experience, and this represents the biggest step in that direction. After all the time and effort I’ve invested into this, it would mean a lot to me.
If anything needs to be fixed quickly before launch, I’m happy to jump on it and address it right away.
Summary of commits
Summary of commits
Infrastructure / Setup
Set up the Astro project from scratch, configured the Netlify deployment, and later moved the Astro project from a subdirectory to the repository root.
Details
CI/CD
Added GitHub Actions workflows for building, linting, and checking links on PRs. Set up Husky for pre-commit hooks, Dependabot for dependency updates, and fixed the Crowdin configuration for translations.
Details
Design / UI Components
Built the full site layout: responsive header and sidebar navigation (mobile, tablet, desktop), footer, homepage hero with optimized WebM/WebP media, features/banner sections, reusable Alert component, blog post page, breadcrumb, and documentation page layout adjustments.
Details
Features
Implemented i18n language selection, blog listing page, and search/chat powered by Orama. Added SEO essentials (sitemap, robots.txt, RSS feed, Open Graph/Twitter Cards, automatic OG image generation). Built documentation features like Table of Contents, prev/next navigation, and rehype plugins for heading links. Added support for global pages, content collections, redirects for legacy links, multi-language translation editing, scripts for pulling external docs, and LLM-friendly API endpoints. Bumped to Astro v6.
Details
Documentation
Wrote overviews for the Application and Express objects and improved API overviews. Migrated remaining Jekyll includes to Astro. Unified headings and API pages for consistency. Adopted the new Alert component across docs. Added security.txt, clustering/middleware images, and project structure documentation. Improved the v5 migration guide (including documenting removed options) and updated routing docs for separate versions.
Details