keyshade-xyz / keyshade

Realtime secret and configuration management tool, with the best in class security and seamless integration support
https://keyshade.xyz
Mozilla Public License 2.0
212 stars 107 forks source link

docs: Add pictures to Bruno setup #541

Closed vr-varad closed 1 week ago

vr-varad commented 1 week ago

Description

Added pictorial representation of setting up Bruno.

Fixes #526

Dependencies

Mention any dependencies/packages used

Future Improvements

Mention any improvements to be done in future related to any file/feature

Mentions

Mention and tag the people

Screenshots of relevant screens

Add screenshots of relevant screens

Developer's checklist

If changes are made in the code:

Documentation Update

codiumai-pr-agent-free[bot] commented 1 week ago

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

**🎫 Ticket compliance analysis ✅** **[526](https://github.com/keyshade-xyz/keyshade/issues/526) - Fully compliant** Compliant requirements: - Added pictures showing Bruno download, opening and collection import steps - Updated documentation to replace Postman references with Bruno
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Image Paths
Verify that all added image paths are correct and the images are properly committed to the repository
codiumai-pr-agent-free[bot] commented 1 week ago

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Score
General
✅ Fix grammatical error in documentation text to improve readability ___ **Fix the typo in "You can find the it in" by removing the extra "the"** [docs/contributing-to-keyshade/running-things-locally/api-testing.md [7]](https://github.com/keyshade-xyz/keyshade/pull/541/files#diff-d481a23b147b665999e737999e42cd2ebed548a3e300750902f78fe07faaf924R7-R7) ```diff -We use Bruno to test our APIs. All of our endpoints are tested using Bruno and we maintain a detailed documentation of every endpoint in our Bruno collection. You can find the it in [here](../../../api-collection/). +We use Bruno to test our APIs. All of our endpoints are tested using Bruno and we maintain a detailed documentation of every endpoint in our Bruno collection. You can find it in [here](../../../api-collection/). ``` `[Suggestion has been applied]`
Suggestion importance[1-10]: 5 Why: The suggestion correctly identifies and fixes a grammatical error ("the it" -> "it") in the documentation, which improves readability and professionalism of the documentation.
5

💡 Need additional feedback ? start a PR chat

vr-varad commented 1 week ago

@rajdip-b Done!!

vr-varad commented 1 week ago

Done @rajdip-b