Skip to content

Conversation

atishaykeploy
Copy link

🚀 Summary
This PR removes several Quickstart Guide frontend buttons from the documentation located at https://keploy.io/docs/. This action aims to streamline the documentation, remove potentially outdated or non-functional examples, and guide users toward our core, maintained quickstart options.

🧹 Changes Implemented
The following specific quickstart options have had their corresponding buttons and links removed from the documentation UI:

  • Gin + Mongo
  • Gin + Redis
  • Flask + MongoDB
  • Sanic + Mongo
  • Flask + Redis
  • Springboot + MongoDB
  • NodeJS - Express + Mongoose
  • Rust + MongoDB (Graphql)
  • Rust + MongoDB (REST)

Motivation and Context
The removal is part of an effort to clean up the Quickstart section and focus user attention on the most current and stable Keploy integration examples. This ensures new users are not directed to examples that may require significant maintenance or are no longer part of the primary focus area.

Testing and Verification

  • Verified the documentation builds successfully.
  • Confirmed that the specified frontend buttons no longer appear in the Quickstart Guide section.
  • Existing functional quickstart guides remain visible and accessible.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you and congratulations 🎉 for opening your very first pull request in keploy

@amaan-bhati amaan-bhati self-requested a review October 10, 2025 11:44
Copy link
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

Hey @atishaykeploy thanks for raising this pr, the ui looks fine, it is removed from the ui and nothing breaks as well. But, i think it is still visible on the sidebar, and it can also be accessed if someone just reaches a particular quickstart's url/route, it's better that we delete the file for each quickstart, so that it gets removed from the sidebar as well as there is no url routed to the quickstart as well.

@amaan-bhati amaan-bhati self-requested a review October 13, 2025 08:14
Copy link
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

hey @atishaykeploy i am not able to see the mongo db and redis quickstarts on the sidebar, so looks good to me. Can you just confirm:

  • nothing breaks on npm run build
  • and the routes are still accesible if we try reaching them manually, without the interaction on the sidebar because there might be backlinks that might be using these links

@atishaykeploy
Copy link
Author

atishaykeploy commented Oct 13, 2025

Hey @amaan-bhati ,

  • I have checked the npm run build and everything seems fine.
image
  • I have also checked the routes of the links removed, and they are still accessible - provided one knows the route name. So, listing them here itself:
  1. NodeJS - Express + Mongoose : /docs/quickstart/express-mongoose-application/
  2. Flask + Redis : /docs/quickstart/flask-redis/
  3. Flask + Mongo : /docs/quickstart/flask-mongo/
  4. Gin + Redis : /docs/quickstart/flask-redis/
  5. Gin + Mongo : /docs/quickstart/samples-gin/
  6. Rust + MongoDB (REST) : /docs/quickstart/sample-rust-crud-mongo/
  7. Warp + Mongo : /docs/quickstart/samples-rust-wrap/
  8. BunJS + Mongo : /docs/quickstart/samples-bunjs/
  9. Potion App (MongoDb) : /docs/quickstart/java-spring-boot-mongo/
  10. SSE + Svelte + MongoDB : /docs/quickstart/samples-sse/
  11. Rust + Mongo (GraphQL) : /docs/quickstart/samples-rust/
  12. Sanic + Mongo : /docs/quickstart/sanic-mongo/
  • I have checked all the links individually, all seem fine.

@amaan-bhati
Copy link
Member

Hey @atishaykeploy Instead if using the custom css for removing each quickstart from the sidebar, you can also try updating the versioned_sidebars/version-3.0.0-sidebars.json file, it might not get reflected on the sidebar immediately, you might have to restart the localhost to see if the changes are actually reflected. Let me know if that method works as well.

@atishaykeploy
Copy link
Author

Hi @amaan-bhati , based on your recommendations, I have :

  • Commented out all the CSS changes I made in the earlier commit.
  • Made the sidebar changes only by removing the items from the code.
  • Checked with npm run build before pushing my changes.

I just left out the Rust : from the sidebar as all the items need to be omitted from there. So, I need the clarification on whether we need to keep it or drop it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants