search

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

chore(web): Update Terms and Conditions and Privacy Policy #282

Closed Aleesssino closed 3 months ago

Aleesssino commented 3 months ago

User description

Description

Fixes #281

Mentions

@kriptonian1

Developer's checklist

If changes are made in the code:

PR Type

documentation, bug fix

Description

Changes walkthrough 📝

Relevant files
Documentation
page.mdx
Update Privacy Policy document with formatting fixes and style
corrections.
apps/web/src/app/(main)/(mdx)/privacy/page.mdx
  • Corrected markdown syntax for headers.
  • Fixed inline style formatting for JSX.
  • Added missing punctuation and improved formatting.
    		•  +41/-22 
    page.mdx
    Comprehensive update to Terms and Conditions document.     
    apps/web/src/app/(main)/(mdx)/terms_and_condition/page.mdx
  • Updated terms and conditions to reflect current policies.
  • Improved formatting and readability.
  • Added detailed sections on services, intellectual property, user
    responsibilities, and dispute resolution.
    		•  +488/-241

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

    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

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

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 4
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review Possible Bug:
    The PR includes changes to the markdown headers (e.g., "## 1. WHAT INFORMATION DO WE COLLECT?" changed to "## 1 WHAT INFORMATION DO WE COLLECT?"). This might affect the rendering or the style of the document if the system expects a specific format.
    Code Consistency:
    The PR changes the style of bullet points inconsistently. In some sections, bullet points are introduced, while in others, the existing format of dashes is maintained. This could lead to inconsistent styling across documents.
    Content Clarity:
    The section on "Withdrawing your consent" in the privacy policy is modified to use JSX for styling, which is good for consistency in a web application. However, ensure that this change is compatible with all browsers and does not affect accessibility.
    codiumai-pr-agent-free[bot] commented 3 months ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Ensure consistency in contact email addresses to avoid confusion ___ **To prevent potential legal issues, ensure that the contact email provided is consistent
    throughout the document. There is a discrepancy between 'support@keyshade.xyz' and
    'support@keyshade.com'. It is crucial to use the correct and consistent email address.** [apps/web/src/app/(main)/(mdx)/terms_and_condition/page.mdx [20-181]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-b74b3c0a98f8466f92e0747acf832728e279e7d3f00ed269f054cb38460d6851R20-R181) ```diff by email at support@keyshade.xyz -Please contact keyshade at support@keyshade.com +Please contact keyshade at support@keyshade.xyz ```
    Suggestion importance[1-10]: 10 Why: Ensuring consistency in contact email addresses is crucial to prevent potential legal issues and user confusion. This suggestion addresses a significant issue in the new code.
    		10
    Enhancement
    Add a table of contents for better navigation and accessibility ___ **To enhance the accessibility and usability of the document, consider adding a table of
    contents at the beginning. This would help users navigate through the various sections
    more efficiently, especially given the document's length and complexity.** [apps/web/src/app/(main)/(mdx)/terms_and_condition/page.mdx [1]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-b74b3c0a98f8466f92e0747acf832728e279e7d3f00ed269f054cb38460d6851R1-R1) ```diff # TERMS AND CONDITIONS +- [Agreement to Our Legal Terms](#agreement-to-our-legal-terms) +- [Our Services](#our-services) +- [Intellectual Property Rights](#intellectual-property-rights) +- [User Representations](#user-representations) +- [Prohibited Activities](#prohibited-activities) +- [User-Generated Contributions](#user-generated-contributions) +- [Contribution License](#contribution-license) +- [Guidelines for Reviews](#guidelines-for-reviews) ```
    Suggestion importance[1-10]: 9 Why: Adding a table of contents significantly enhances the usability and accessibility of the document, especially given its length and complexity. This is a valuable enhancement for user experience.
    		9
    Specify server locations to enhance transparency in data transfer disclosures ___ **It's beneficial to specify the location of the servers when mentioning international data
    transfers to maintain transparency and trust with the users. This could be a specific
    country or region.** [apps/web/src/app/(main)/(mdx)/privacy/page.mdx [73]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-7377dd7e703eee6d7f836dff64fbd7ed22ee00e2924fe89ac771071813fe0b35R73-R73) ```diff -Our servers are located in. If you are accessing our Services from outside, please be aware that your information may be transferred to, stored, and processed by us in our facilities and by those third parties with whom we may share your personal information (see "WHEN AND WITH WHOM DO WE SHARE YOUR PERSONAL INFORMATION?" above), in and other countries. +Our servers are located in [specific country or region]. If you are accessing our Services from outside, please be aware that your information may be transferred to, stored, and processed by us in our facilities and by those third parties with whom we may share your personal information (see "WHEN AND WITH WHOM DO WE SHARE YOUR PERSONAL INFORMATION?" above), in [specific country or region] and other countries. ```
    Suggestion importance[1-10]: 9 Why: Specifying the server location enhances transparency and trust, which is crucial for user confidence in data handling practices. This is a significant improvement for legal and user trust reasons.
    		9
    Standardize the date format for clarity and consistency ___ **To ensure clarity and consistency, consider using a consistent date format throughout the
    document. The date format "April 11, 2024" could be standardized to a more universally
    accepted format such as "11 April 2024" or "2024-04-11" to avoid regional ambiguities.** [apps/web/src/app/(main)/(mdx)/terms_and_condition/page.mdx [4]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-b74b3c0a98f8466f92e0747acf832728e279e7d3f00ed269f054cb38460d6851R4-R4) ```diff -Last updated: April 11, 2024. +Last updated: 2024-04-11. ```
    Suggestion importance[1-10]: 7 Why: Standardizing the date format can improve clarity and avoid regional ambiguities, making the document more universally understandable. However, this is a minor enhancement and not crucial.
    		7
    Improve readability and context by adding an introductory sentence before section headers ___ **Consider adding a brief introductory sentence before jumping directly into the section
    headers to improve the flow and context for the reader. This can help in setting the stage
    for the detailed sections that follow.** [apps/web/src/app/(main)/(mdx)/privacy/page.mdx [10]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-7377dd7e703eee6d7f836dff64fbd7ed22ee00e2924fe89ac771071813fe0b35R10-R10) ```diff -+ +In this section, we explain the types of information we collect from you. ## 1. WHAT INFORMATION DO WE COLLECT? ```
    Suggestion importance[1-10]: 7 Why: Adding an introductory sentence can improve readability and provide better context for the reader, making the document more user-friendly. However, it is not a critical change.
    		7
    Maintainability
    Remove redundant phrases to improve document conciseness ___ **It's recommended to avoid redundancy in the text to make the document more concise and
    easier to read. The phrase "collectively, the 'Agreement'" is repeated unnecessarily and
    can be removed in one instance to improve readability.** [apps/web/src/app/(main)/(mdx)/terms_and_condition/page.mdx [43]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-b74b3c0a98f8466f92e0747acf832728e279e7d3f00ed269f054cb38460d6851R43-R43) ```diff -(collectively, the "Agreement"). If you do not agree to this Agreement, you may not use, access, or submit information to the Services. (collectively, the "Agreement"). If you do not agree to this Agreement, you may not use, access, or submit information to the Services. +If you do not agree to this Agreement, you may not use, access, or submit information to the Services. ```
    Suggestion importance[1-10]: 8 Why: Removing redundant phrases improves readability and conciseness, which is important for maintaining a professional and clear document. This suggestion directly addresses a readability issue in the new code.
    		8
    Clarity
    Clarify the age limit for data collection from minors to enhance understanding and legal clarity ___ **To enhance clarity and avoid potential legal ambiguities, explicitly state the age limit
    when discussing the collection of information from minors, rather than using the term
    "children under 18 years of age."** [apps/web/src/app/(main)/(mdx)/privacy/page.mdx [89]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-7377dd7e703eee6d7f836dff64fbd7ed22ee00e2924fe89ac771071813fe0b35R89-R89) ```diff -We do not knowingly solicit data from or market to children under 18 years of age. +We do not knowingly solicit data from or market to individuals under the age of 18. ```
    Suggestion importance[1-10]: 8 Why: Clarifying the age limit improves legal clarity and user understanding, which is important for compliance and clear communication.
    		8
    Readability
    Use simpler and more engaging language to make the privacy notice more accessible ___ **For better user engagement and clarity, consider using more engaging and less technical
    language in the introductory sentences of each section. This can make the document more
    accessible to a broader audience.** [apps/web/src/app/(main)/(mdx)/privacy/page.mdx [35]](https://github.com/keyshade-xyz/keyshade/pull/282/files#diff-7377dd7e703eee6d7f836dff64fbd7ed22ee00e2924fe89ac771071813fe0b35R35-R35) ```diff -_In Short: We process your information to provide, improve, and administer our Services, communicate with you, for security and fraud prevention, and to comply with law. We may also process your information for other purposes with your consent._ +_Simply put: We use your information to enhance our services, communicate with you, ensure security, and meet legal requirements. Sometimes, we might use your information for other reasons, but we'll get your consent first._ ```
    Suggestion importance[1-10]: 6 Why: Using simpler language can make the document more accessible to a wider audience, improving user engagement. However, the current language is already clear, so this is a minor enhancement.
    		6
    rajdip-b commented 3 months ago

    @kriptonian1 yo ser drop your reviews!

    Aleesssino commented 3 months ago

    I think after this updates it should be good to merge

    Done 🚀

    rajdip-b commented 3 months ago

    @kriptonian1 can you review this now?

    kriptonian1 commented 3 months ago

    Sorry guys, I was not available. Let me review it for you