Skip to content

feat(ci): add lychee broken link test#14231

Merged
skjnldsv merged 6 commits intomasterfrom
feat/ci-lychee
Apr 24, 2026
Merged

feat(ci): add lychee broken link test#14231
skjnldsv merged 6 commits intomasterfrom
feat/ci-lychee

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

@skjnldsv skjnldsv commented Apr 3, 2026

This pull request brings a big quality boost to our documentation workflow! 🚀

Goal:

Make sure every internal link in our docs actually works, and catch broken ones before anything gets published. We want contributors and users to trust that our docs are always reliable and easy to navigate.

What’s new:

🔗 Automated link checking:
A new CI job uses Lychee to scan all generated documentation for broken links.

🧹 Relative links everywhere:

All internal doc links are now relative paths instead of hardcoded URLs. This makes the docs easier to maintain and less likely to break if we move things around.

Simpler workflow:

No more fetching the gh-pages branch just to check links. The process is faster and easier to follow.

Why this matters:

  • 🛡️ No more broken links slipping through, users always get a smooth experience.
  • 🛠️ Contributors get instant feedback if a link is broken, so fixes happen before merge.
  • 📚 Docs are easier to reorganize and maintain, with less risk of accidental breakage.
  • ⏱️ Faster, more reliable CI runs.

@skjnldsv skjnldsv self-assigned this Apr 3, 2026
@skjnldsv skjnldsv added enhancement 2. developing github_actions Pull requests that update GitHub Actions code labels Apr 3, 2026
@skjnldsv skjnldsv force-pushed the feat/ci-lychee branch 26 times, most recently from d2d4a70 to 0b645ad Compare April 7, 2026 17:05

This comment was marked as resolved.

@skjnldsv
Copy link
Copy Markdown
Member Author

skjnldsv commented Apr 23, 2026

Sorry for the failed rebase @all 😢

Comment thread .github/workflows/sphinxbuild.yml Outdated
@skjnldsv
Copy link
Copy Markdown
Member Author

It's done!! 🚀

Summary

Status Count
🔍 Total 38767
✅ Successful 29141
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 9626
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0

Comment thread admin_manual/ai/overview.rst Outdated
@skjnldsv
Copy link
Copy Markdown
Member Author

Done @nickvergessen

Summary

Status Count
🔍 Total 38777
✅ Successful 29160
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 9617
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0

Comment thread admin_manual/configuration_database/mysql_4byte_support.rst Outdated
Comment thread admin_manual/configuration_server/config_sample_php_parameters.rst Outdated
Comment thread user_manual/desktop/uninstallation.rst Outdated
skjnldsv and others added 4 commits April 24, 2026 12:40
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>

Co-authored-by: skjnldsv <14975046+skjnldsv@users.noreply.github.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/ae18fa2c-5300-4ccd-9db7-6f2c00da3a4b

Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@skjnldsv
Copy link
Copy Markdown
Member Author

FINALLY

@nickvergessen
Copy link
Copy Markdown
Member

Pushed a last commit:

Before After
Bildschirmfoto vom 2026-04-24 13-56-20 Bildschirmfoto vom 2026-04-24 13-57-54

Copilot AI and others added 2 commits April 24, 2026 14:50
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/0eeab2cf-94b4-4068-b59b-d8eae342c840

Co-authored-by: nextcloud-command <88102737+nextcloud-command@users.noreply.github.com>
Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants