expressjs / expressjs/expressjs.com

Documentation Enhancement Request – Add "Example" Column/Tab for All The Properties

Open
#2,364 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
5.4k
Forks
2.3k
Avg merge
2d 23m
Merged PRs (30d)
14

Description

### Description

Hello Express Team,

I would like to suggest a small documentation enhancement for pages such as `express.Router([options])`.

Currently, the documentation shows the property name, description, default value, and availability. While this explains what a property does, it does not show how to use it in practice.

For options like `mergeParams`, `caseSensitive`, and `strict`, I often need to leave the documentation and search Google or Stack Overflow for implementation examples.

A possible improvement would be to add either:

* An **Example** column beside each property, or
* An **Example** tab containing:

* Example code
* Common use cases
* Expected behavior/output

Example:

```js
const router = express.Router({
mergeParams: true
});
```

This would make the documentation more practical, reduce external searches, and help developers understand features more quickly.

Thank you for considering this suggestion and for maintaining Express.

Best regards

Image

### Expectations

Image

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.