Add required tools for documentation build to devcontainer
Open
@mgajek-cern is already working on this.
Since Dec 1, 2025.
enhancement
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Description:
To streamline the development setup and ensure consistency, we should install all necessary tools for building the documentation inside the devcontainer.
Missing tools to install:
-
mdl ([markdownlint](https://github.com/markdownlint/markdownlint))
gem install mdl
Additional steps:
-
Install Python dependencies from
tools/requirements.txtusing:python3 -m pip install -r tools/requirements.txt -
Install website dependencies by running:
(cd website && yarn install)
Goal:
Developers should have a ready-to-go environment with all prerequisites installed inside the devcontainer for documentation development and testing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.