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

vr-varad · 2024-06-11T09:45:09Z

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

My PR follows the style guidelines of this project
I have performed a self-check on my work

If changes are made in the code:

I have followed the coding guidelines
My changes in code generate no new warnings
My changes are breaking another fix/feature of the project
I have added test cases to show that my feature works
I have added relevant screenshots in my PR
There are no UI/UX issues

Documentation Update

This PR requires an update to the documentation at docs.keyshade.xyz
I have made the necessary updates to the documentation, or no documentation changes are required.

PR Type

Documentation

Description

Added new documentation for the web application.
Detailed the tech stack including Next.js, React, MDX, Tailwind CSS, Framer Motion, Geist, @tsparticles, Sonner, and TypeScript.
Explained the directory structure, including app, components, and utils directories.

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 · 2024-06-11T09:45:27Z

PR Reviewer Guide 🔍

(Review updated until commit `ffbd107`)

⏱️ Estimated effort to review [1-5]	1
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	None

codiumai-pr-agent-free · 2024-06-11T09:45:30Z

PR Code Suggestions ✨

No code suggestions found for PR.

vr-varad · 2024-06-11T09:45:36Z

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

rajdip-b · 2024-06-11T09:50:35Z

Converted it to draft!

vr-varad · 2024-06-12T08:49:32Z

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

rajdip-b

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

codiumai-pr-agent-free · 2024-06-12T09:04:40Z

Persistent review updated to latest commit ffbd107

codiumai-pr-agent-free · 2024-06-12T09:04:44Z

PR Code Suggestions ✨

No code suggestions found for PR.

kriptonian1 · 2024-06-12T13:48:24Z

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

let me have a look

docs/contributing-to-keyshade/design-of-our-code/web.md

sonarcloud · 2024-06-12T15:39:09Z

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 · 2024-06-12T15:39:33Z

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

kriptonian1 · 2024-06-12T17:12:06Z

docs/contributing-to-keyshade/design-of-our-code/web.md

+    |      |                    ├── privacy
+    |      |                    └── terms_and_condition


Don't show files, just show the folders. As files changes often.

kriptonian1 · 2024-06-12T17:15:34Z

@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 · 2024-06-13T04:09:37Z

@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 · 2024-06-28T04:55:51Z

@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.

rajdip-b

The content looks good. Just that you forgot to reference this file in the index, so it's not showing up:

Reference the new file in this and this files.

vr-varad · 2024-06-28T05:40:04Z

Done @rajdip-b

rajdip-b

LGTM 🚀

rajdip-b · 2024-06-28T05:42:57Z

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

## [2.2.0](v2.1.0...v2.2.0) (2024-07-11) ### 🚀 Features * **api-client:** Added API Client package ([#346](#346)) ([6734e1e](6734e1e)) * **api:** Updated API key ([fbac312](fbac312)) * **platform:** View [secure]s ([#313](#313)) ([97c4541](97c4541)) * **web:** Add Pricing Page ([#243](#243)) ([2c7f1d6](2c7f1d6)) ### 📚 Documentation * **cli:** Added docs for the CLI package ([#329](#329)) ([edad166](edad166)) * **cli:** Added usage docs ([#330](#330)) ([b6963d5](b6963d5)) * Update Discord link ([871b6cd](871b6cd)) * Update README.md ([e66fcd2](e66fcd2)) * **web:** Add documentation about our web package ([#268](#268)) ([3d848e7](3d848e7)) ### 🔧 Miscellaneous Chores * **api:** Updated response types in environment service ([b8a3ddd](b8a3ddd)) * **ci:** Added release scripts for platform and api ([02dae60](02dae60)) * **CI:** Updated action plugin versions ([88bb317](88bb317)) * **CI:** Updated pnpm version in CI file ([2692e88](2692e88)) * **platform:** Fixed env parsing in platform ([d6ffafa](d6ffafa)) * **web:** Update Terms and Conditions and Privacy Policy ([#282](#282)) ([d621dcb](d621dcb)) ### 🔨 Code Refactoring * **api:** Update [secure] and variable fetching endpoints ([7d9acd0](7d9acd0)) * **cli:** Refactored profile commands into readable blocks ([#331](#331)) ([4a8a089](4a8a089)) * **cli:** Updated configuration commands and mechanism ([#310](#310)) ([9079b6d](9079b6d))

codiumai-pr-agent-free bot added the Documentation label Jun 11, 2024

codiumai-pr-agent-free bot added the Review effort [1-5]: 1 label Jun 11, 2024

vr-varad changed the title ~~Adding documentation about our web package~~ feat: Adding documentation about our web package Jun 11, 2024

rajdip-b changed the title ~~feat: Adding documentation about our web package~~ docs(web): Add documentation about our web package Jun 11, 2024

rajdip-b marked this pull request as draft June 11, 2024 09:50

vr-varad added 2 commits June 12, 2024 14:32

Adding Docs for Homepage

9a90517

Added Structure for web folder

ffbd107

rajdip-b reviewed Jun 12, 2024

View reviewed changes

rajdip-b marked this pull request as ready for review June 12, 2024 09:04

kriptonian1 reviewed Jun 12, 2024

View reviewed changes

docs/contributing-to-keyshade/design-of-our-code/web.md Outdated Show resolved Hide resolved

kriptonian1 reviewed Jun 12, 2024

View reviewed changes

docs/contributing-to-keyshade/design-of-our-code/web.md Outdated Show resolved Hide resolved

docs/contributing-to-keyshade/design-of-our-code/web.md Outdated Show resolved Hide resolved

Added Tree format for structure and refined structure description

948d12c

kriptonian1 reviewed Jun 12, 2024

View reviewed changes

kriptonian1 linked an issue Jun 26, 2024 that may be closed by this pull request

Add docs for running the web locally #185

Closed

vr-varad added 2 commits June 28, 2024 10:19

Merge branch 'keyshade-xyz:develop' into develop

9147b41

Removed Files

21e5025

rajdip-b requested changes Jun 28, 2024

View reviewed changes

Added Web reference in Summary and Readme

c063cd0

rajdip-b approved these changes Jun 28, 2024

View reviewed changes

rajdip-b merged commit b272df3 into keyshade-xyz:develop Jun 28, 2024
5 checks passed

yogesh1801 pushed a commit to yogesh1801/keyshade that referenced this pull request Jun 29, 2024

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

49a04d3

rajdip-b pushed a commit that referenced this pull request Jul 11, 2024

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

3d848e7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

vr-varad commented Jun 11, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Jun 11, 2024 •

edited

Loading

codiumai-pr-agent-free bot commented Jun 11, 2024

vr-varad commented Jun 11, 2024

rajdip-b commented Jun 11, 2024

vr-varad commented Jun 12, 2024

rajdip-b left a comment

codiumai-pr-agent-free bot commented Jun 12, 2024

codiumai-pr-agent-free bot commented Jun 12, 2024

kriptonian1 commented Jun 12, 2024

sonarcloud bot commented Jun 12, 2024

vr-varad commented Jun 12, 2024

kriptonian1 Jun 12, 2024

kriptonian1 commented Jun 12, 2024 •

edited

Loading

rajdip-b commented Jun 13, 2024

vr-varad commented Jun 28, 2024

rajdip-b left a comment

vr-varad commented Jun 28, 2024

rajdip-b left a comment

rajdip-b commented Jun 28, 2024

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

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

Conversation

vr-varad commented Jun 11, 2024 • edited by codiumai-pr-agent-free bot Loading

User description

Description

Dependencies

Future Improvements

Mentions

Screenshots of relevant screens

Developer's checklist

Documentation Update

PR Type

Description

Changes walkthrough 📝

codiumai-pr-agent-free bot commented Jun 11, 2024 • edited Loading

PR Reviewer Guide 🔍

(Review updated until commit ffbd107)

codiumai-pr-agent-free bot commented Jun 11, 2024

PR Code Suggestions ✨

vr-varad commented Jun 11, 2024

rajdip-b commented Jun 11, 2024

vr-varad commented Jun 12, 2024

rajdip-b left a comment

Choose a reason for hiding this comment

codiumai-pr-agent-free bot commented Jun 12, 2024

codiumai-pr-agent-free bot commented Jun 12, 2024

PR Code Suggestions ✨

kriptonian1 commented Jun 12, 2024

sonarcloud bot commented Jun 12, 2024

Quality Gate passed

vr-varad commented Jun 12, 2024

kriptonian1 Jun 12, 2024

Choose a reason for hiding this comment

kriptonian1 commented Jun 12, 2024 • edited Loading

rajdip-b commented Jun 13, 2024

vr-varad commented Jun 28, 2024

rajdip-b left a comment

Choose a reason for hiding this comment

vr-varad commented Jun 28, 2024

rajdip-b left a comment

Choose a reason for hiding this comment

rajdip-b commented Jun 28, 2024

vr-varad commented Jun 11, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Jun 11, 2024 •

edited

Loading

(Review updated until commit `ffbd107`)

kriptonian1 commented Jun 12, 2024 •

edited

Loading