Give every page a meta description and test SITE-013 - #8
Merged
Conversation
SITE-013 asks every page to declare a meta description. Two of the eight did. It was the last requirement in the specification with no test, and a test would have failed, which is presumably why it was never written. Adds descriptions to the six pages without one, drawn from what the README already says each page contains, and adds the check. The check also rejects a description under 40 characters: one short enough to be a placeholder passes a presence test while telling a search result or a shared link nothing. The shortest real description here is 118 characters, so the floor has room. Verified the descriptions survive into the live DOM rather than only existing in the source: the deck runtime rewrites <helmet> into the head on boot, so a static head tag could plausibly have been dropped or duplicated. Exactly one survives on each page. Confirmed the test fails when a description is removed. The level stays SHOULD. Every page satisfies it and it is now covered, so it no longer shows as an untested requirement. Raising it to MUST would be a change to what the gate enforces, which RFC 0004 establishes needs its own proposal.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Independent of #6 and #7. Targets
maindirectly.What
SITE-013asks every page to declare a meta description. Two of eight did. It was the last requirement in the specification with no test, and a test written against the old state would have failed on six pages, which is presumably why nobody wrote one.index.html,beta.htmlsolar-system.dc.htmljunocam-explorer.dc.htmljunocam-deck.dc.htmlpocket-planetarium.htmlthe-moons.dc.htmljunocam-poster.dc.htmlThe copy is drawn from what the README already says each page contains, so it describes the real thing rather than inventing a pitch.
The test
Checks presence, and rejects anything under 40 characters. A description short enough to be a placeholder passes a presence check while telling a search result or a shared link nothing. The shortest genuine one here is 118 characters, so the floor has plenty of room and is not tuned to the current content.
Confirmed it fails when a description is removed, naming the offending page.
Checked the descriptions actually reach the browser
The
.dc.htmlpages hold their head content in a<helmet>block that the runtime rewrites into the document on boot, so a static<meta>in the head could plausibly have been stripped or duplicated. It is not: exactly one survives on each page, with the right content.Result
npm test: 22/22 validation, traceability OK, 104/104 browser, 0 failuresSITE-013no longer appears in the traceability report as untestedWith #7 merged, the report will have no uncovered requirements at any level.
The level stays SHOULD
Every page now satisfies it and it is covered, so it is no longer an unkept promise. Raising it to MUST would change what the gate enforces, which RFC 0004 establishes needs its own proposal. Say the word and I will write it.