r-devel / r-dev-day

Repo to organize tasks for R Dev Days
7 stars 2 forks source link

R Dev Container: improve formating, sectioning, etc in general edit of docs #61

Open hturner opened 1 month ago

hturner commented 1 month ago

This is issue 191 on the R Dev Container repo, looking for people to do a general edit to fix minor issues, e.g. ensuring markdown lists are properly formatted and lists/sub-sections use a consistent style.

Although this could be done by making a detailed list of things that need fixing, ideally the source code would be edited to make the fixes.

The docs are written in a set of markdown files in the docs folder of the R Dev Container repo.

The docs are built with mkdocs using Python as described in the Contributing to Docs section.

ns-rse commented 1 month ago

It might be worth applying markdownlint-cli2 to the documentation. It could also be applied as a pre-commit hook and integrated via pre-commit.ci so that checks are made when contributions are made.

See also #145 which suggests using vale.

EDIT : Captured as a new issue #65 as issue 191 may cover additional formatting issues that linters may not catch.