QUERY · ISSUE

docs.micropython.org/ should redirect to stable release version.

openby jedieopened 2019-12-06updated 2019-12-09

docs

As https://github.com/micropython/micropython/issues/5387 shows, there are contents in the documentation that are not yet available in the official downloads.

These should be marked in the docs.

CANDIDATE · PULL REQUEST

docs/conf.py: Set "version" and "release" to the same value.

closedby pfalconopened 2017-07-01updated 2017-07-02

We don't use alpha/beta/RC, so for us version and release should be the
same, or it leads to confusion (for example, current, 1.9.1 docs are
marked as 1.9 at places).

Assessment

Q Qwen · medium

Issue #5389 requests that docs.micropython.org redirect to stable release versions or clearly mark content not yet available in official downloads to prevent user confusion. PR #3189 addresses a related but distinct issue: fixing the Sphinx configuration (docs/conf.py) to ensure 'version' and 'release' fields are consistent, preventing internal documentation version mismatches (e.g., showing 1.9.1 docs as 1.9). While both items concern documentation versioning and user confusion, PR #3189 fixes the internal version display in the generated docs, whereas Issue #5389 is about the website's routing behavior and deployment strategy (redirecting to stable versions). The PR does not resolve the specific request in the issue regarding site redirection or marking pre-release content.

Suggested action

Keep both items open. The PR addresses internal version consistency, but the issue regarding site redirection and content parity marking remains unresolved.

docs.micropython.org/ should redirect to stable release version.

docs/conf.py: Set "version" and "release" to the same value.

Keyboard