Skip to content

doc(readme): use absolute upgrade-guide link#21

Merged
jfrosorio merged 3 commits into
v1from
doc-19-v1
Jul 14, 2026
Merged

doc(readme): use absolute upgrade-guide link#21
jfrosorio merged 3 commits into
v1from
doc-19-v1

Conversation

@jfrosorio

@jfrosorio jfrosorio commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Closes #28

  • The relative (UPGRADE.md) link 404s when the README is rendered outside GitHub; replaced with the absolute URL to the v1 branch's upgrade guide
  • The LICENSE links pointed at a nonexistent master branch; now point at v1

Note: since this PR targets v1 (not the default branch), GitHub won't auto-close #28 on merge — it gets closed manually afterwards.

Copilot AI left a comment

Copy link
Copy Markdown

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 updates the v1 branch README to use branch-correct, absolute GitHub links so documentation renders correctly outside GitHub and avoids dead links.

Changes:

  • Replaced the relative UPGRADE.md link with an absolute https://github.com/.../blob/v1/UPGRADE.md URL.
  • Updated README license links (badge + license section) from the nonexistent master branch to v1.
  • Reformatted the requirements table for consistent Markdown rendering.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jfrosorio
jfrosorio merged commit ff22a85 into v1 Jul 14, 2026
1 check passed
@jfrosorio
jfrosorio deleted the doc-19-v1 branch July 14, 2026 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants