docs: fix formatting in html coding standards #80
Conversation
kshitij-k-osmosys
added
the
documentation
WalkthroughThis update focuses solely on formatting improvements in the HTML coding standards document. The changes include adding line breaks and spacing adjustments before specific sections and examples to improve readability. Additionally, a trailing space was removed to ensure consistency. No content or functional guidelines were altered, and no new features or changes to control flow were introduced. Changes
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
coding-standards/html.md (4)
10-11: Enhanced Section Header Formatting:
The header "HTML is a Markup Language:" now appears on its own line, which significantly improves readability. As an optional note, verify that the term "markup" meets your style preference—whether intended as a noun or in a verbal sense.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: The word “markup” is a noun. The verb is spelled with a white space.
Context: ...is a Markup Language**: HTML is used to markup your document and not style it. We have...(NOUN_VERB_CONFUSION)
253-254: Trailing Whitespace Removal and Punctuation Suggestion:
The cleanup of trailing whitespace on this line contributes to consistency in the document. As a minor nitpick, consider adding a comma after "Example :" to further improve punctuation and readability.
286-287: Clarify Prefix Guidelines:
The lines detailing the prefix usage seem a bit unclear. To improve clarity, consider rewording them to:"The following prefixes should be used for the corresponding HTML elements:"
This rephrasing would make the guideline more explicit for the reader.
354-354: Format Bare URL as a Markdown Link:
The ESLint URL on this line is presented as a bare URL. For consistency with documentation best practices, consider formatting it as a markdown link (e.g.,[ESLint Plugin for HTML](https://github.com/BenoitZugmeyer/eslint-plugin-html)). This change will improve both readability and style compliance.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
354-354: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
coding-standards/html.md(10 hunks)
🧰 Additional context used
🪛 LanguageTool
coding-standards/html.md
[grammar] ~11-~11: The word “markup” is a noun. The verb is spelled with a white space.
Context: ...is a Markup Language**: HTML is used to markup your document and not style it. We have...
(NOUN_VERB_CONFUSION)
[typographical] ~252-~252: It seems that a comma is missing.
Context: ... think anything else is more appropriate please contact your mentor. - The document cha...
(IF_PLEASE_COMMA)
🪛 markdownlint-cli2 (0.17.2)
coding-standards/html.md
133-133: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
148-148: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
354-354: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (6)
coding-standards/html.md (6)
13-14: Clear Demarcation for DOCTYPE Section:
The header "Always Specify a DOCTYPE:" is now clearly separated from the surrounding content, making the guideline more prominent.
112-113: Improved Formatting for List Items Section:
The added line break preceding the "Write One List Item per Line" header enhances clarity and separation of the content, making the section easier to follow.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
113-113: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
132-138: Consistent Formatting in Empty Elements Section:
The adjustments around the instruction on avoiding ending empty elements with a/(lines 132 and 138) improve the visual consistency between the “Bad” and “Good” examples. This makes it clearer for readers to compare and understand the guideline.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
133-133: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
147-154: Clarified Progression of Heading Tags:
The spacing and formatting in the "Proper Progression of Heading Tags" section now better illustrate the correct hierarchy (fromh1toh2toh3). The improved examples facilitate easier comprehension.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
148-148: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
247-247: Enhanced Readability in Input Type Guidelines:
The inserted line break in this section (line 247) helps separate the recommendation for specifying proper input types, thereby emphasizing its importance—especially for mobile optimization considerations.
339-339: Enhanced Separation with Blank Line:
The additional blank line inserted at line 339 provides a clear visual break between sections, which enhances overall document readability.
kshitij-k-osmosys
changed the title
kshitij-k-osmosys
changed the title
Description
Fix formatting for html coding standards document
Summary by CodeRabbit
Documentation
Style