Skip to content

fix: convert relative links to absolute URLs in changelog docs#373

Merged
davidpoblador merged 1 commit into
mainfrom
fix/docs-broken-links
Nov 6, 2025
Merged

fix: convert relative links to absolute URLs in changelog docs#373
davidpoblador merged 1 commit into
mainfrom
fix/docs-broken-links

Conversation

@davidpoblador

Copy link
Copy Markdown
Member

Summary

Fix mkdocs strict mode build failures by converting relative links to absolute GitHub URLs

Problem

The docs workflow was failing with:

WARNING - Doc file 'changelog.md' contains a link '../CONTRIBUTING.md'
WARNING - Doc file 'changelog.md' contains a link '../AGENTS.md'
Aborted with 3 warnings in strict mode!

Solution

  • Replace relative links (../CONTRIBUTING.md, ../AGENTS.md) with absolute GitHub URLs
  • Fix MD013 line length violations by breaking long lines
  • Keep --strict flag enabled for quality assurance

MkDocs cannot resolve links to files outside the docs directory, so absolute URLs are needed.

🤖 Generated with Claude Code

Replace relative links (../CONTRIBUTING.md, ../AGENTS.md) with absolute GitHub URLs
to fix mkdocs strict mode build failures. MkDocs cannot resolve links to files outside
the docs directory.

Also fix MD013 line length violations.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude

claude Bot commented Nov 6, 2025

Copy link
Copy Markdown

Claude finished @davidpoblador's task —— View job


Code Review Progress

  • Read and analyze the modified changelog.md file
  • Review code quality and implementation approach
  • Check for potential bugs or issues
  • Evaluate performance considerations
  • Assess security concerns
  • Consider test coverage requirements
  • Provide comprehensive feedback

@davidpoblador davidpoblador merged commit a3ab5cb into main Nov 6, 2025
2 checks passed
@davidpoblador davidpoblador deleted the fix/docs-broken-links branch November 6, 2025 10:21
davidpoblador pushed a commit that referenced this pull request Nov 6, 2025
🤖 I have created a release *beep* *boop*
---


##
[2.13.5](v2.13.4...v2.13.5)
(2025-11-06)


### Bug Fixes

* convert relative links to absolute URLs in changelog docs
([#373](#373))
([a3ab5cb](a3ab5cb))
* include chore commits in changelog
([#379](#379))
([44ffea3](44ffea3))
* include refactor and perf commits in changelog
([#378](#378))
([f98e9df](f98e9df))


### Code Refactoring

* remove template backwards compatibility symlink
([#377](#377))
([3ba7e11](3ba7e11))


### Miscellaneous Chores

* add gh pr list and gh run list permissions
([#380](#380))
([6fb0642](6fb0642))
* add permissions for uvx uv-bump and gh pr create
([#375](#375))
([27e392a](27e392a))
* **deps:** update JavaScript and Python dependencies
([#374](#374))
([0370036](0370036))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

1 participant