Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
hturner opened this issue Sep 5, 2024 · 1 comment
Labels
Documentation Issues in the documentation RSECon24

Comments

@hturner
Copy link
Member

hturner commented Sep 5, 2024

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.

@hturner hturner added Documentation Issues in the documentation RSECon24 labels Sep 5, 2024
@ns-rse
Copy link

ns-rse commented Sep 5, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues in the documentation RSECon24
Projects
None yet
Development

No branches or pull requests

2 participants