Skip to content

Fix docs build failure caused by unresolved MkDocs strict-mode links - #277

Merged
ruoyuwang1995nya merged 4 commits into
develfrom
copilot/fix-github-actions-build-job
Sep 11, 2026
Merged

ruoyuwang1995nya merged 4 commits into
develfrom
copilot/fix-github-actions-build-job

Conversation

Copilot AI commented Sep 11, 2026 •

Copy link
Copy Markdown
Contributor

The build Actions job failed because mkdocs build --strict treated two links in docs/remote_job_monitoring.md as unresolved documentation targets. This PR updates those links so documentation builds no longer abort on warnings.

  • Root cause

    • remote_job_monitoring.md linked to files under src/.../references via relative paths outside the MkDocs docs tree, which strict mode flags as missing doc targets.
  • Change

    • Replaced the two broken relative links with canonical GitHub blob URLs pointing to the same reference documents.
  • Updated section (example)

    - See the [Batch Job skill reference](../src/matcreator/skills/remote-job/references/bohr-batchjob-ref.md)
    - and [VASP Batch Job guide](../src/matcreator/skills/vasp-pymatgen/references/bohr-batchjob.md).
    
    + See the [Batch Job skill reference](https://github.com/AI4MS/MatCreator/blob/main/src/matcreator/skills/remote-job/references/bohr-batchjob-ref.md)
    + and [VASP Batch Job guide](https://github.com/AI4MS/MatCreator/blob/main/src/matcreator/skills/vasp-pymatgen/references/bohr-batchjob.md).

Co-authored-by: ruoyuwang1995nya <53182543+ruoyuwang1995nya@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix failing GitHub Actions job build Fix docs build failure caused by unresolved MkDocs strict-mode links Sep 11, 2026
@ruoyuwang1995nya
ruoyuwang1995nya changed the base branch from main to devel September 11, 2026 04:01
@ruoyuwang1995nya
ruoyuwang1995nya marked this pull request as ready for review September 11, 2026 04:03
@ruoyuwang1995nya
ruoyuwang1995nya merged commit 6746867 into devel Sep 11, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants