Feedback links

[kbatuigas]

This pull request introduces feedback links to various API documentation overlays, enabling users to easily report documentation issues via GitHub. Additionally, it updates a quickstart guide link to ensure correct navigation.

Enhancements to API documentation:

• Added shared/overlays/cloud-add-feedback-link.yaml to provide a feedback button in the Control Plane and Data Plane API docs, allowing users to submit documentation update requests through GitHub.
• Added shared/overlays/sm-add-feedback-link.yaml to provide a feedback button in the HTTP Proxy, Schema Registry, and Admin API docs for reporting documentation issues.

Documentation fixes:

• Updated the "See also" link in cloud-controlplane/x-topics/quickstart.md to point to the correct Data Plane API Quickstart documentation.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Updated a documentation file (cloud-controlplane/x-topics/quickstart.md): corrected a “See also” link to point to /api/doc/cloud-dataplane/topic/topic-quickstart and fixed a bullet formatting issue in the Suggested reading section by replacing a stray double-dash with a single bullet marker.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Clarify auth flows #15: Also updates the same quickstart.md with similar link and quickstart content changes.

Suggested reviewers

• micheleRP

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch kbatuigas-patch-1

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

cloud-controlplane/x-topics/quickstart.md (1)

89-89: Fix stray backtick in inline code formatting

There’s an extra backtick before https:// which breaks the inline code formatting.

Apply this diff to fix the formatting:

-1. From the value of `dataplane_api.url` in the response body, save the subdomain (the part between ``https://` and `.cloud.redpanda.com`).
+1. From the value of `dataplane_api.url` in the response body, save the subdomain (the part between `https://` and `.cloud.redpanda.com`).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17fde8e and 59a5bbd.

📒 Files selected for processing (1)

• cloud-controlplane/x-topics/quickstart.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

cloud-controlplane/x-topics/quickstart.md

[grammar] ~98-~98: There might be a mistake here.
Context: ...rking/) for BYOC and Dedicated clusters. - Manage [authentication and authorization...

(QB_NEW_EN)

🔇 Additional comments (2)

cloud-controlplane/x-topics/quickstart.md (2)

94-94: Link fix looks correct and aligns with API docs pathing

The updated “See also” link now points to the expected /api/doc/cloud-dataplane/topic/topic-quickstart path.

If you want to double-check for broken links during CI or locally, consider running a markdown link checker over the docs directory.

---

100-100: Bullet formatting fix improves readability

Replacing the stray double-dash with a proper bullet is correct; the link and anchor look good.

[JakeSCahill]

@kbatuigas this one is good to merge. The Bump team will add support for feedback links in HTTP and SR APIs.