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
196 stars 96 forks source link

docs(web): Add documentation about our web package #268

Closed vr-varad closed 3 months ago

vr-varad commented 3 months ago

User description

Description

Give a summary of the change that you have made

Fixes #219

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


PR Type

Documentation


Description


Changes walkthrough 📝

Relevant files
Documentation
web.md
Add documentation for web application structure and stack

docs/contributing-to-keyshade/design-of-our-code/web.md
  • Added documentation for the web application.
  • Described the tech stack used in the web application.
  • Provided a detailed directory structure explanation.
  • +56/-0   

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-free[bot] commented 3 months ago

    PR Reviewer Guide 🔍

    (Review updated until commit https://github.com/keyshade-xyz/keyshade/commit/ffbd107c82e69e9dd4ba6073547a83b29c914231)

    ⏱️ Estimated effort to review [1-5] 1
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review None
    codiumai-pr-agent-free[bot] commented 3 months ago

    PR Code Suggestions ✨

    No code suggestions found for PR.

    vr-varad commented 3 months ago

    Would be adding to this pr as I find add more about webpage.

    rajdip-b commented 3 months ago

    Converted it to draft!

    vr-varad commented 3 months ago

    @rajdip-b I have added stack and structure is there anymore than can be added

    codiumai-pr-agent-free[bot] commented 3 months ago

    Persistent review updated to latest commit https://github.com/keyshade-xyz/keyshade/commit/ffbd107c82e69e9dd4ba6073547a83b29c914231

    codiumai-pr-agent-free[bot] commented 3 months ago

    PR Code Suggestions ✨

    No code suggestions found for PR.

    kriptonian1 commented 3 months ago

    This looks good to me! @kriptonian1 what do you think?

    let me have a look

    sonarcloud[bot] commented 3 months ago

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues
    0 Accepted issues

    Measures
    0 Security Hotspots
    No data about Coverage
    No data about Duplication

    See analysis details on SonarCloud

    vr-varad commented 3 months ago

    @rajdip-b DId some changes can u have a look whenever you have a chance?

    kriptonian1 commented 3 months ago

    @rajdip-b , do you believe it would be appropriate to mention the Next.js convention files separately, or should we simply provide a link to the Next.js website for contributors to access the file structure?

    rajdip-b commented 3 months ago

    @rajdip-b , do you believe it would be appropriate to mention the Next.js convention files separately, or should we simply provide a link to the Next.js website for contributors to access the file structure?

    Just a link would be sufficient ig

    vr-varad commented 3 months ago

    @rajdip-b was not well for a week so couldn't work on it. Will be regular from now. Are there any more changes required I have removed the files and kept only folders.

    vr-varad commented 3 months ago

    Done @rajdip-b

    rajdip-b commented 3 months ago

    Thanks for the PR! We would need to add a lot of technical docs, so if you are interested, do ping us on Discord so we can walk you through the requirements :D