← index #5389PR #9668
Likely Duplicate · high · value 2.986
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/templates/layout.html: Indicate latest vs release docs.

closedby jimmoopened 2022-10-18updated 2022-10-26
docs

This aims to address some recent confusion noted in discussions. Right now, when looking at the latest docs, it says "1.19.1" in the top left hand corner, and has no indication that it actually refers to the in-development version.

This PR changes it so that when looking at latest (the default for docs.micropython.org), it's clear that this isn't the release version.

  • Changes the version in the top-left to "latest".
  • Adds a message to the top of each page to highlight this.

For release versions, add a short message to link to the latest version. This won't apply to existing releases, but will start applying to any future releases.

This is based on how the Zephyr docs work -- see:
https://docs.zephyrproject.org/latest/develop/getting_started/index.html
https://docs.zephyrproject.org/3.2.0/develop/getting_started/index.html

This work was funded through GitHub Sponsors.

Keyboard

j / / n
next pair
k / / p
previous pair
1 / / h
show query pane
2 / / l
show candidate pane
c
copy suggested comment
r
toggle reasoning
g i
go to index
?
show this help
esc
close overlays

press ? or esc to close

copied