fix: Audit and fix broken links in README#2013
Merged
Conversation
- Fixed 15 broken /core-concepts/* links in README.yaml to use new URL structure - Added 5 missing redirects in docusaurus.config.js for backward compatibility - Uncommented workflows redirect with corrected target URL - Created link-check.yml GitHub Action to automatically check .md files for broken links using lychee Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
|
Important Cloud Posse Engineering Team Review RequiredThis pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes. To expedite this process, reach out to us on Slack in the |
Dependency Review✅ No vulnerabilities or license issues found.Scanned Files
|
osterman
added
the
no-release
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2013 +/- ##
==========================================
+ Coverage 75.36% 75.38% +0.01%
==========================================
Files 792 792
Lines 73396 73396
==========================================
+ Hits 55313 55326 +13
+ Misses 14570 14562 -8
+ Partials 3513 3508 -5
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
- Add UTM exclusion patterns to link-check.yml workflow - Delete reference to private repo (infra-live/pull/1640) - Fix testing-strategy.md references to use correct filename - Fix atmos-error-handling.md references to use correct filename - Fix unified-flag-parsing-refactoring.md references in flag-handling docs - Fix /core-concepts/* URLs in example READMEs - Add additional redirects to docusaurus.config.js for backward compatibility Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
📝 WalkthroughWalkthroughAdds repository-wide documentation link updates to reflect site restructuring and introduces automated Markdown link checking via a new GitHub Actions workflow, lychee configuration, and a Makefile target. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as "Developer / PR"
participant GH as "GitHub Actions"
participant LycheeAction as "lychee-action v2"
participant LycheeConfig as "lychee.toml (repo)"
participant Repo as "Repository files"
Dev->>GH: Open PR / push
GH->>LycheeAction: Trigger link-check job
LycheeAction->>Repo: Load `**/*.md` list (exclude website)
LycheeAction->>LycheeConfig: Read settings (timeout, retries, accept, excludes)
LycheeAction->>LycheeAction: Perform HTTP checks for each link
LycheeAction-->>GH: Report status (pass/fail)
GH->>Dev: Job result + job summary
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Enable jobSummary output so link checker results render as markdown in the GitHub Actions job summary instead of raw console output. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Update snapshot to reflect fixed URL in README (core-concepts/stacks → stacks). Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
- Add --base flag to lychee for correct GitHub file path resolution - Add wttr.in exclusion for unreliable service - Fix /core-concepts/* URLs to new URL structure in docs and examples - Update redirect URLs to point directly to final destinations: - charm.sh/blog → charm.land/blog - specifications.freedesktop.org/basedir-spec → basedir - cloud.google.com → docs.cloud.google.com - terraform.io → developer.hashicorp.com/terraform - github.com/imdario/mergo → github.com/darccio/mergo - github.com/cloudposse/reference-architectures → cloudposse-archives Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
osterman
force-pushed
the
osterman/fix-readme-links
branch
from
5ac4c26 to
93772ba
Compare
- Add lychee.toml for centralized link checker configuration - Add `make link-check` target for local iteration - Update GitHub Action to use config file with GITHUB_TOKEN - Fix broken file references in docs/prd/ files (double path prefixes) - Fix testing-strategy.md → testability-refactoring-strategy.md - Fix PRD-Atmos-Auth.md path references - Fix quick-start links in examples/README.md - Update cobra docs URL (master→cobra.dev) - Update termenv URL (charmbracelet→muesli) - Remove broken worktree reference in component-registry-pattern.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
osterman
force-pushed
the
osterman/fix-readme-links
branch
from
93772ba to
f915e78
Compare
- Add GNU.org URLs to lychee exclusion list to avoid rate limits - Fix invalid redirect destinations in docusaurus.config.js: - /stacks/naming → /stacks/name - /stacks/templates → /templates - /workflows/workflow-manifest → /workflows - /vendor/vendor-manifest → /vendor/vendor-config Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Docusaurus requires the trailing slash for the /vendor/ path. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@docs/prd/sso-role-auto-discovery.md`:
- Line 1462: The documentation line labeled "**Specification**" contains a wrong
XDG spec URL path (uses "basedir/"); update the URL to the correct path by
replacing
"https://specifications.freedesktop.org/basedir/basedir-spec-latest.html" with
either
"https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html"
or the canonical "https://specifications.freedesktop.org/basedir-spec/latest/"
so the link resolves correctly.
In `@examples/README.md`:
- Around line 50-54: The link targets and descriptions are inverted: the text
"simple quick start" currently links to /quick-start/advanced and the text
"advanced quick start" points at quick-start-simple/; update the hrefs so
"demo-stacks" and the "simple quick start" text link to quick-start-simple/ (or
the simple quick start URL) and the "quick-start-simple" mention for the
advanced section points to the /quick-start/advanced (or quick-start-advanced/)
target so that demo-stacks, quick-start-simple and quick-start-advanced
references match their intended descriptions.
In `@tests/test-cases/hooks-component-scoped/README.md`:
- Around line 92-94: You modified test assets under tests/test-cases which the
repo forbids; revert the changes made to README.md in the hooks-component-scoped
test case and any edits to the corresponding test implementation
(hooks_component_scope_test.go) and hooks code unless you have explicit approval
from the maintainers; if an exception is required, add a short approval note
from a maintainer to the PR description before keeping the changes.
🧹 Nitpick comments (2)
docs/prd/auth-list-command.md (1)
1416-1417: Convert bare URL to a Markdown link (optional cleanup).
MD034 flags the bare URL; suggest a follow-up cleanup (non-blocking for PRDs).🧩 Suggested tweak
-- Configure authentication: https://atmos.tools/cli/commands/auth/login +- Configure authentication: [https://atmos.tools/cli/commands/auth/login](https://atmos.tools/cli/commands/auth/login)Based on learnings, markdownlint issues in docs/prd should be handled in a separate cleanup PR.
docs/development.md (1)
26-26: Reminder: run the website build after doc changes.
Per repo guidance, please runcd website && npm run buildto validate no broken links or MDX render issues.
- Fix XDG spec URL path (basedir/ → basedir-spec/) - Fix swapped quick-start folder references and URLs in examples/README.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
osterman
removed
the
no-release
The getting_started.md URLs were updated from /core-concepts/* to the new paths. Regenerating golden snapshots to match. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
aknysh
approved these changes
Jan 23, 2026
|
These changes were released in v1.204.1-rc.5. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
what
/core-concepts/*links in README that returned 404 errorswhy
GitHub reported 404 errors for several README links pointing to moved documentation pages. Adding redirects provides backward compatibility for external references, and the new link checker prevents future broken link regressions.
references
Related to: https://github.com/cloudposse/atmos/issues (README broken links audit)
Summary by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.