Docs: Fix broken links - #717
Conversation
Signed-off-by: Ed Snible <snible@us.ibm.com>
📝 WalkthroughWalkthroughDocumentation-only updates refresh Rossoctl installation links, correct AuthBridge cross-references, remove an outdated binary reference, and point security reporting guidance to GitHub’s advisory form. ChangesDocumentation updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@authbridge/README.md`:
- Line 9: Update the README statement near “Two container images are published”
to accurately describe the table: state that there are two base images plus the
authbridge-lite build variant, or revise the count to reflect all three listed
image identifiers.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 28424d67-b71c-4aac-814c-b6920b274780
📒 Files selected for processing (9)
CLAUDE.mdSECURITY.mdauthbridge/README.mdauthbridge/cmd/README.mdauthbridge/demos/README.mdauthbridge/demos/github-issue/demo-manual.mdauthbridge/demos/weather-agent/demo-ui.mdauthbridge/demos/weather-agent/demo-with-abctl.mdauthbridge/docs/plugin-tutorial.md
| ## Deployment Modes | ||
|
|
||
| The [`cmd/authbridge/`](./cmd/authbridge/) directory contains a unified binary that supports three deployment modes in a single codebase. Two container images are published: | ||
| Two container images are published: |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify the published-image count.
This says two container images are published, but the table lists three image identifiers, including authbridge-lite. Please state that there are two base images plus the authbridge-lite build variant, or update the count.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@authbridge/README.md` at line 9, Update the README statement near “Two
container images are published” to accurately describe the table: state that
there are two base images plus the authbridge-lite build variant, or revise the
count to reflect all three listed image identifiers.
github-project-automation
Bot
moved this from New/ToDo
to Done
in Rossoctl Issue Prioritization
|
|
||
| - **UI Deployment**: See [demo-ui.md](demo-ui.md) for deploying via the Rossoctl dashboard | ||
| - **AuthBridge Binary**: See the [AuthBridge README](../../cmd/authbridge/README.md) for inbound | ||
| - **AuthBridge Binary**: See the [AuthBridge README](../../cmd/authbridge-envoy/README.md) for inbound |
There was a problem hiding this comment.
There's https://github.com/rossoctl/cortex/blob/main/authbridge/cmd/README.md but not a README under https://github.com/rossoctl/cortex/tree/main/authbridge/cmd/authbridge-envoy - which one should this link to?
4 participants
Summary
Fix the broken links reported by
lychee --no-progress './**/*.md' --exclude-path aiac --exclude-path authbridge/demos/github-issue --exclude-path go/pkg/mod/github.com --exclude-path go/pkg/mod/golang.org --exclude-path docs/proposalsFixes #
Resolves #714
Resolves #713
Resolves #712
Resolves #711
Resolves #697
Resolves #696
Resolves #695
Resolves #694
Summary by CodeRabbit