Improve HTML style #7313
Improve HTML style #7313
Conversation
📝 WalkthroughWalkthroughAcross five documentation HTML files, void elements were reformatted from self-closing syntax to non-self-closing HTML5 style. Affected tags include meta (Content-Type, viewport, Refresh) and link rel="icon". Attributes and values remain unchanged; no additions, removals, or content edits. No changes to DOM structure, rendering behavior, control flow, or logic. Files updated: docs/checker-framework-quick-start.html, docs/checker-framework-webpage.html, docs/developer/developer-manual.html, docs/developer/gsoc-ideas.html, and docs/developer/new-contributor-projects.html. Pre-merge checks and finishing touches✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/developer/gsoc-ideas.html (1)
12-14: Fix visible redirect link: double “.html”.The anchor text shows
...new-contributor-projects.html.html. Correct to a single.html. The meta refresh already targets the right file.-Redirecting to <a href="https://checkerframework.org/manual/new-contributor-projects.html.html">https://checkerframework.org/manual/new-contributor-projects.html.html</a>. +Redirecting to <a href="https://checkerframework.org/manual/new-contributor-projects.html">https://checkerframework.org/manual/new-contributor-projects.html</a>.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
docs/checker-framework-quick-start.html(1 hunks)docs/checker-framework-webpage.html(1 hunks)docs/developer/developer-manual.html(1 hunks)docs/developer/gsoc-ideas.html(1 hunks)docs/developer/new-contributor-projects.html(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
- GitHub Check: typetools.checker-framework (typecheck_part2_jdk25)
- GitHub Check: typetools.checker-framework (misc_jdk25)
- GitHub Check: typetools.checker-framework (nonjunit_jdk25)
- GitHub Check: typetools.checker-framework (typecheck_part1_jdk25)
- GitHub Check: typetools.checker-framework (junit_jdk25)
- GitHub Check: typetools.checker-framework (inference_part2_jdk25)
- GitHub Check: typetools.checker-framework (inference_part1_jdk25)
- GitHub Check: build - 97259673
- GitHub Check: build - 97259673
- GitHub Check: build
- GitHub Check: typetools.checker-framework (typecheck_part1_jdk25)
- GitHub Check: typetools.checker-framework (misc_jdk25)
- GitHub Check: typetools.checker-framework (junit_jdk25)
- GitHub Check: typetools.checker-framework (typecheck_part2_jdk25)
- GitHub Check: typetools.checker-framework (inference_part1_jdk25)
- GitHub Check: typetools.checker-framework (inference_part2_jdk25)
- GitHub Check: typetools.checker-framework (nonjunit_jdk25)
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Looks good; minor head cleanups recommended.
- Use
<meta charset="utf-8">and addlangon<html>for a11y/i18n.
-<html>
+<html lang="en">
@@
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta charset="utf-8">🤖 Prompt for AI Agents
In docs/checker-framework-quick-start.html around lines 5 to 6, the head uses an
older content-type meta and the html tag lacks a lang attribute; replace the
Content-Type meta with a simpler <meta charset="utf-8"> and add a lang attribute
(e.g., lang="en") to the <html> element to improve accessibility and
internationalization.
| <head><link rel="icon" type="image/png" href="favicon-checkerframework.png" /> | ||
| <title>The Checker Framework</title> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
LGTM on meta; align the rest of head to the same style.
- Convert the self-closing favicon link for consistency and prefer .
-<head><link rel="icon" type="image/png" href="favicon-checkerframework.png" />
+<head><link rel="icon" type="image/png" href="favicon-checkerframework.png">
@@
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta charset="utf-8">Also consider <html lang="en">.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| <head><link rel="icon" type="image/png" href="favicon-checkerframework.png"> | |
| <meta charset="utf-8"> |
🤖 Prompt for AI Agents
In docs/checker-framework-webpage.html around line 5, replace the old
Content-Type meta with a modern <meta charset="utf-8">, update the favicon link
to the same non-self-closing HTML style used elsewhere (e.g., <link rel="icon"
href="..."> without a trailing slash), and add lang="en" to the opening <html>
tag to match the suggested accessibility/consistency changes.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <link rel="icon" href="../manual/favicon-checkerframework.png" type="image/png"> |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Good HTML5 void-element normalization; consider modernizing head.
- Replace http-equiv Content-Type with the shorter, standard HTML5 form and set document language.
-<html>
+<html lang="en">
@@
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta charset="utf-8">📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <link rel="icon" href="../manual/favicon-checkerframework.png" type="image/png"> | |
| <html lang="en"> | |
| <meta charset="utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <link rel="icon" href="../manual/favicon-checkerframework.png" type="image/png"> |
🤖 Prompt for AI Agents
In docs/developer/developer-manual.html around lines 5 to 7, the head uses the
legacy http-equiv Content-Type meta and the document lacks a language attribute;
replace the http-equiv meta with the HTML5 shorthand meta charset declaration
and ensure the top-level <html> tag includes a proper lang attribute (e.g.,
lang="en"); keep the favicon link but move or confirm these changes appear early
in the document head for correct HTML5 normalization.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=yes"> | ||
| <meta http-equiv="Refresh" content="1; URL=new-contributor-projects.html"> | ||
| </head> |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Meta/style change is correct; keep modernizing head.
- Prefer
<meta charset="utf-8">andlang="en"on<html>.
-<html>
+<html lang="en">
@@
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta charset="utf-8">📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=yes"> | |
| <meta http-equiv="Refresh" content="1; URL=new-contributor-projects.html"> | |
| </head> | |
| <html lang="en"> | |
| <head> | |
| <meta charset="utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=yes"> | |
| <meta http-equiv="Refresh" content="1; URL=new-contributor-projects.html"> | |
| </head> |
🤖 Prompt for AI Agents
In docs/developer/gsoc-ideas.html around lines 5 to 8, modernize the head by
replacing the older <meta http-equiv="Content-Type" content="text/html;
charset=utf-8"> with the simpler <meta charset="utf-8"> and ensure the root
<html> tag includes lang="en"; keep the viewport and refresh tags as-is but
update the HTML tag and charset meta to the modern forms.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Nice normalization; one more small head tweak.
- Swap http-equiv for
<meta charset>and addlangon<html>.
-<html>
+<html lang="en">
@@
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+ <meta charset="utf-8">📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <html lang="en"> | |
| <meta charset="utf-8"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
🤖 Prompt for AI Agents
In docs/developer/new-contributor-projects.html around lines 5 to 6, replace the
legacy <meta http-equiv="Content-Type" ...> with the modern <meta
charset="utf-8"> and ensure the top-level <html> tag includes a lang attribute
(e.g., lang="en"); update the HTML head to use the new meta charset declaration
and add or modify the <html> start tag to include an appropriate language code
for accessibility and correctness.
No description provided.