DOC-1545 Remove legacy rapidoc support

[JakeSCahill]

Do not release until 20 August 2025. Relies on redpanda-data/docs-site#113

This pull request removes the Swagger and Rapidoc integrations from the project, along with associated files, tasks, and configurations. It also includes minor dependency adjustments and updates to documentation to reflect the changes.

Removal of Swagger and Rapidoc Integrations:

• README.adoc: Updated to reflect the removal of the swagger.hbs layout, reducing the total number of layouts from six to five.
• gulpfile.js: Removed references to Rapidoc, including the copyRapidoc task and its associated source and destination paths. Updated build and preview tasks to exclude Rapidoc-related steps. [1] [2] [3] [4] [5]
• package.json: Removed the rapidoc and marked-highlight dependencies, which were no longer needed after the removal of Rapidoc. [1] [2]
• src/css/site.css and src/css/swagger.css: Removed references to and the entire swagger.css stylesheet, as it is no longer used. [1] [2]
• src/helpers/get-api-slots.js: Deleted the helper script used for processing API pages and wrapping content with Rapidoc slots.
• src/js/06-copy-to-clipboard.js: Removed logic that excluded Swagger/Rapidoc blocks from having duplicate copy buttons.
• src/layouts/oauth.hbs: Deleted the OAuth layout, which dynamically loaded the rapidoc-min.js file.

Updates to Documentation and Content:

• preview-src/cloud-api.adoc: Removed the API-specific metadata and layout configuration related to Swagger.
• preview-src/index.adoc: Removed the "API preview" section and its link to the Cloud API page.

These changes simplify the project by removing unused or deprecated features and dependencies, reducing maintenance overhead.

[netlify]

✅ Deploy Preview for docs-ui ready!

Name	Link
🔨 Latest commit	ca8de84
🔍 Latest deploy log	https://app.netlify.com/projects/docs-ui/deploys/68a34de6c275c900077b36ef
😎 Deploy Preview	https://deploy-preview-319--docs-ui.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 41 Accessibility: 93 Best Practices: 100 SEO: 88 PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[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

This set of changes systematically removes all code, configuration, assets, and documentation related to Rapidoc and Swagger UI from the project. It deletes the swagger.hbs and oauth.hbs layout templates, the swagger.css stylesheet, helper functions for API slot processing, and the cloud-api.adoc preview source. All references to Rapidoc and Swagger are removed from build scripts, CSS imports, the static files manifest, and package dependencies. The documentation is updated to reflect the removal of the Swagger layout, and UI logic for theme handling and copy-to-clipboard is adjusted to eliminate Rapidoc-specific conditions. Links and references to the removed API documentation are also deleted.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant BuildSystem
    participant UI
    participant Rapidoc/Swagger (removed)

    Developer->>BuildSystem: Initiate build
    BuildSystem--xRapidoc/Swagger (removed): No longer copies Rapidoc assets
    BuildSystem->>UI: Build UI without Rapidoc/Swagger layouts or assets
    UI--xRapidoc/Swagger (removed): No longer renders API docs with Rapidoc/Swagger
    UI->>User: Render UI without Rapidoc/Swagger components

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Remove all Rapidoc code and references from the UI (DOC-1545)	✅

Suggested reviewers

• kbatuigas

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch remove-rapidoc

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.