doc: meta-issue: provide typo trains to fix typos easily
This is a meta-issue, don't close it, ever.
This meta-issue is about encouraging readers of the documentation to fix typos and other minor, non-controversial and non-urgent issues.
This is done by regularly creating typo train MRs, as a vehicle for batching several commits in a dedicated branch called typo-doc
.
The scope of typo train fixes includes:
- the technical documentation under
docs/
(published at https://tezos.gitlab.io/) - the documentation in the code (under
src/
and other directories), including:- docstrings and other comments within programs and interfaces,
- README.md files,
-
.mld
files.
On the other hand, the typo train is not well suited for:
- possibly controversial changes, i.e. that need to be discussed with several people before being applied
- patches to be applied urgently (note that this is a usual limitation for public transports ;-) )
A typo train has two distinct modes:
- As long as the it is in
Draft
mode, it is open to contributions, so teel free to add your own ones in branchtypo-doc
. - When the typo train is marked
Ready
, it is closed to contributions and open to approvals.
Reviews are always welcome, but when performed in Draft
mode, you should not Approve the train, as you cannot assume all its passengers are onboard.
The current and past editions of the typo train are based on source branch tezos/tezos:typo-doc
:
current typo train -->
Older editions, based on source branch nomadic-labs/tezos:typo-doc
:
Thanks to @germanD for the original idea of creating the typo train.
Happy active reading to everyone!