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

Fix incorrect nesting of tags in README.md #895

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

famouswizard
Copy link

Description:
This pull request addresses an issue in the README file where the <h1> tag was incorrectly nested inside a <p> tag. In HTML, the <h1> tag is a block-level element, while the <p> tag is an inline element. This incorrect nesting leads to invalid HTML structure, which can cause rendering issues and break the layout in some cases.

Fix:

The following incorrect nesting:

<p align="center">
    <h1 align="center">
        Semaphore CLI
    </h1>
    <p align="center">A command line tool to set up your Semaphore project and get group data.</p>
</p>

has been corrected to:

<h1 align="center">
    Semaphore CLI
</h1>
<p align="center">A command line tool to set up your Semaphore project and get group data.</p>

This change ensures that the structure of the document is semantically correct and will render as intended across different browsers and platforms.

Why this is important:
Correct HTML structure is critical for the proper display of content on web pages. Nested block-level elements like <h1> inside inline elements like <p> can cause layout issues or unexpected behavior, especially in older browsers or when using CSS frameworks. Fixing this ensures better compatibility and cleaner code.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have run yarn format and yarn lint without getting any errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Fix incorrect nesting of tags
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant