DOC-1545 Remove legacy rapidoc support #319
Conversation
✅ Deploy Preview for docs-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis set of changes systematically removes all code, configuration, assets, and documentation related to Rapidoc and Swagger UI from the project. It deletes the 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
Estimated code review effort🎯 4 (Complex) | ⏱️ ~40 minutes Assessment against linked issues
Suggested reviewers
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (13)
💤 Files with no reviewable changes (10)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
🔇 Additional comments (4)
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Do not merge 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 theswagger.hbslayout, reducing the total number of layouts from six to five.gulpfile.js: Removed references to Rapidoc, including thecopyRapidoctask 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 therapidocandmarked-highlightdependencies, which were no longer needed after the removal of Rapidoc. [1] [2]src/css/site.cssandsrc/css/swagger.css: Removed references to and the entireswagger.cssstylesheet, 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 therapidoc-min.jsfile.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.