-
Notifications
You must be signed in to change notification settings - Fork 244
docs: Remove deprecated Quickstart links for MongoDB and Redis integrations #699
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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
There was a problem hiding this 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.
There was a problem hiding this 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
Hey @amaan-bhati ,
![]()
|
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. |
Signed-off-by: unknown <[email protected]>
Hi @amaan-bhati , based on your recommendations, I have :
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. |
🚀 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:
❓ 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