-
Notifications
You must be signed in to change notification settings - Fork 9
Fix documentation link checker errors #112
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
base: main
Are you sure you want to change the base?
Conversation
Resolved 32 broken file links identified by the nightly link checker: 1. Fixed relative paths in docs/developer/branding.md by adding ../ prefix to correctly reference branding assets from the subdirectory 2. Commented out broken API reference link in docs/index.md 3. Removed broken research directory links for eagle3 and hass sections All branding assets exist in docs/assets/branding/ but were incorrectly referenced without proper relative path traversal from the developer/ subdirectory. Fixes link checker failures in nightly CI workflow. Signed-off-by: [email protected] <[email protected]> Signed-off-by: Rahul Tuli <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes broken documentation links that were causing CI failures in the nightly link checker workflow. The fixes address incorrect relative paths to branding assets and remove references to non-existent documentation directories.
- Updated relative paths for branding assets from
assets/branding/
to../assets/branding/
- Commented out the API Reference section until API documentation is created
- Converted broken research section links to plain text descriptions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
docs/index.md | Commented out API Reference section and converted research links to plain text |
docs/developer/branding.md | Fixed relative paths for all branding asset references |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
📦 Build Artifacts Available |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn’t break our docs, does it?
I will double check before requesting a review, this PR is Claude-generated! |
Maybe cleaner to set this in mkdocs.yml instead? https://www.mkdocs.org/user-guide/configuration/#validation-of-absolute-links |
Summary
Resolves 32 broken file links identified by the nightly link checker workflow that were causing CI failures.
Root Cause
The documentation had two categories of broken links:
docs/developer/branding.md
used relative paths that didn't account for the subdirectory structureChanges
Fixed Branding Asset Links
docs/developer/branding.md
to use../assets/branding/
instead ofassets/branding/
Removed Broken Directory Links
docs/index.md
until API docs are created./research/eagle3/
and./research/hass/
directoriesValidation
docs/assets/branding/
Impact