Skip to content
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

refactor: Changed the text in the hero section of the web application #579

Conversation

poswalsameer
Copy link
Contributor

@poswalsameer poswalsameer commented Dec 5, 2024

User description

Description

This PR changes the text that can be seen in the hero section of the web application.

Dependencies

No dependencies

Future Improvements

Mentions

Mention and tag the people

Screenshots of relevant screens

Screenshot 2024-12-05 194342

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

enhancement


Description

  • Refactored the hero section of the web application to update the text content.
  • Improved the text layout using flexbox for better alignment and readability.
  • Enhanced the messaging to clearly convey the purpose of the application as a .env file replacement.

Changes walkthrough 📝

Relevant files
Enhancement
index.tsx
Refactor hero section text and layout                                       

apps/web/src/components/hero/index.tsx

  • Updated text content in the hero section.
  • Changed text layout to use flexbox for better alignment.
  • Improved readability by splitting text into paragraphs.
  • +3/-3     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Accessibility
    The text content is split into paragraphs but uses

    tags inside a . Consider using more semantic HTML structure with proper heading levels and paragraph elements.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Use semantic HTML elements to improve accessibility and document structure

    Add semantic HTML by using

    or
    instead of for text content blocks, as spans are
    meant for inline elements, not block-level content with paragraphs.

    apps/web/src/components/hero/index.tsx [91-94]

    -<span className="text-brandBlue/80 flex flex-col justify-center w-[20rem] text-center text-sm md:w-[35rem] md:text-xl md:leading-[3rem]">
    +<section className="text-brandBlue/80 flex flex-col justify-center w-[20rem] text-center text-sm md:w-[35rem] md:text-xl md:leading-[3rem]">
       <p>The better .env file replacement</p>
       <p>Built for developers, by developers</p>
    -</span>
    +</section>
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Using

    instead of for block-level content with paragraphs is semantically correct and improves accessibility. This change follows HTML best practices and makes the document structure more meaningful.

    7

    💡 Need additional feedback ? start a PR chat

    @rajdip-b rajdip-b enabled auto-merge (squash) December 6, 2024 07:32
    @rajdip-b rajdip-b disabled auto-merge December 13, 2024 04:45
    @rajdip-b rajdip-b merged commit a92925f into keyshade-xyz:develop Dec 13, 2024
    4 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants