Documentation build should be strict (especially in CI)

Open
  • Is something wrong?
#512 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
build-system, documentation

Research direction

The log lines name broken anchors in pages such as tutorial/performance.md, tutorial/troubleshooting.md and tutorial/access/proxy.md, reported at INFO level. Start by finding where the docs build sets its link-validation level, then decide whether to raise it to warning or error. Done means a strict build fails on these broken anchors, and the listed links are fixed or the build passes.

Written by the indexing model from the issue text.

Description

There are a number of info statements right now that are really more like errors:

INFO    -  Doc file 'blog/posts/2025/03/gpu-support-eessi.md' contains a link '../../../../site_specific_config/gpu.md#installing-full-cuda-sdk-optional', but the doc
           'site_specific_config/gpu.md' does not contain an anchor '#installing-full-cuda-sdk-optional'.
INFO    -  Doc file 'test-suite/ReFrame-configuration-file.md' contains a link '#RFM_PREFIX', but there is no such anchor on this page.
INFO    -  Doc file 'tutorial/configuration_hpc.md' contains a link '#in-memory-cache', but there is no such anchor on this page.
INFO    -  Doc file 'tutorial/performance.md' contains a link 'eessi/high-level-design.md#compat_layer', but the doc 'tutorial/eessi/high-level-design.md' does not contain
           an anchor '#compat_layer'.
INFO    -  Doc file 'tutorial/troubleshooting.md' contains a link '#cache', but there is no such anchor on this page.
INFO    -  Doc file 'tutorial/access/alternatives.md' contains a link '../configuration_hpc.md#alien-cache', but the doc 'tutorial/configuration_hpc.md' does not contain
           an anchor '#alien-cache'.
INFO    -  Doc file 'tutorial/access/proxy.md' contains a link 'client.md##minimal_configuration', but the doc 'tutorial/access/client.md' does not contain an anchor
           '##minimal_configuration'.
Dominant language
Python
Stars
14
Forks
54
Avg merge
11h 2m
Merged PRs (30d)
41

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EESSI/docs

All issues in EESSI/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.