webpack / webpack/webpack.js.org

Add docs' versions in URLs

Open
#6,142 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
2.3k
Forks
3.4k
Avg merge
13h 32m
Merged PRs (30d)
71

Description

Problem

From our source code and documentation, linking to a library's "latest" docs may fail after a while, because the version has changed, and possibly that link may not even exist anymore. So it's best practice to link to a specific version.

So for example, it's better to link to https://webpack.js.org/v5/concepts/#entry than to https://webpack.js.org/concepts/#entry or https://webpack.js.org/latest/concepts/#entry, etc.

The docs site however only has implicit "latest", and v4 is on a different subdomain.

The latest version is 5.x.x, and we can't link to it.

Solution

Please add the "latest" version as well, e.g. "5.72.1". If that would get burdensome to update each time, then just "5.x.x" or "5" or "v5" would be fine too.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the webpack.js.org configuration or entry point that defines the documentation site's current version and URL paths. Check how versioned and latest links are generated, then verify that the latest webpack 5 version has a stable URL form and that documentation links use it consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
webpack
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.