Skip to content

docs: fix broken README and example-guide links - #798

Open
soyeladice-svg wants to merge 2 commits into
cuga-project:mainfrom
soyeladice-svg:docs/fix-links-797
Open

soyeladice-svg wants to merge 2 commits into
cuga-project:mainfrom
soyeladice-svg:docs/fix-links-797

Conversation

@soyeladice-svg

@soyeladice-svg soyeladice-svg commented Sep 29, 2026 •

Copy link
Copy Markdown

Summary

  • fix the reversed Adding Tools Markdown link
  • add a stable HTML anchor for the LLM configuration details block
  • fix the relative path from the CUGA-as-MCP guide to the main README

Validation

  • exactly two files changed, matching issue scope
  • documentation-only; no code, dependencies, permissions, workflows, secrets, or runtime behavior changed
  • verified the relative path depth and anchor target against the current repository layout

Closes #797

AI assistance was used to prepare this documentation change.

Summary by CodeRabbit

  • Documentation
    • Added a link target for the advanced LLM configuration section and corrected the “Adding Tools” link.
    • Updated the example’s Quick Start link to point to the repository-root README.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: cuga-project/cuga-agent/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: c943b151-f2af-41b0-8d9d-50907a4a68aa

📥 Commits

Reviewing files that changed from the base of the PR and between 934d5d8 and 8b35e1a.

📒 Files selected for processing (2)
  • README.md
  • docs/examples/cuga_as_mcp/README.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The README now includes an anchor for the advanced LLM configuration section, and the “Adding Tools” link points to the example README. The CUGA as MCP guide now links to the repository-root README.

Changes

Documentation links

Layer / File(s) Summary
README anchors and link targets
README.md, docs/examples/cuga_as_mcp/README.md
The README adds the advanced LLM configuration anchor and corrects the “Adding Tools” link. The CUGA as MCP guide changes its relative link to the repository-root README.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other · Severity of issue fixed: Low

Suggested labels: readability: good, complexity: low

Merge Risk: ⚪ Minimal · up to 8b35e

The documentation navigation changes point to the intended pages and section. No merge-blocking risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 8b35e

The change affects 2 systems.

Changed systems: docs, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Added the llm-configuration---advanced-options anchor.
  • observed — Modified behavior in README.md: Corrected the “Adding Tools” link so it points to the example README and displays “Adding Tools.”
  • observed — Modified behavior in docs/examples/cuga_as_mcp/README.md: The LLM configuration link now points to ../../../README.md rather than ../../README.md.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation changes to fix broken README and example-guide links.
Linked Issues check ✅ Passed The whole-PR diff satisfies all coding objectives in issue #797. README.md adds the llm-configuration---advanced-options anchor before the <details> block and corrects the “Adding Tools” link te…
Out of Scope Changes check ✅ Passed The diff changes only README.md and docs/examples/cuga_as_mcp/README.md. Each change directly supports the three link fixes in issue #797. No unrelated source, test, or configuration changes are p…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot added complexity: low Small, focused change — easy to review readability: good Clear PR goal and description; easy to review labels Sep 29, 2026

@offerakrabi offerakrabi left a comment •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

additions look fine.
only thing is per our CONTRIBUTING.md, all commits must be signed off with the -s flag.

e.g.

git commit -s -m "commit message"

This branch is waiting to be deployed

1 waiting deployment
external-testing — 8b35e1ae Waiting Sep 29, 2026 by soyeladice-svg via Wheel install + demo_crm OpenAPI (fork, external-testing) #1019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

complexity: low Small, focused change — easy to review readability: good Clear PR goal and description; easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix three broken links in the README and example guides

2 participants