Summary
Follow-up to #168. That issue found that pages without an explicit description: front matter field fall back to Hugo's auto-generated .Summary for og:description, which produces garbled text when a page's body is a list of short, disconnected fragments rather than prose. #168 / PR #170 fixed this for News and Adoptions, but the same root cause affects other pages that were not covered by that fix.
Affected pages
-
content/en/docs/project/timeline.md — a list of **YEAR**: fragment entries (16 of them), same shape as the News page. Auto-summary truncates at ~70 words mid-entry, jamming unrelated years together, e.g.:
"2010: Improving upon the Thandy software updater for the Tor private browser, Justin Samuel and Justin Cappos collaborate to design and publish an academic research paper on The Update Framework (TUF). 2011: TUF Project moves to New York University Polytechnic School of Engineering (later NYU Tandon School of Engineering) when Justin Cappos accepts a post as an assistant professor at the Brooklyn, NY, sch…"
-
content/en/docs/security/audits.md — a bare list of dated audit report links with trailing fragments ("covering PHP-TUF and Rugged", etc.). Auto-summary strips the links/bullets and runs the dates and fragments together into nonsense.
-
content/en/resources/publications.md — a bare list of paper title links with no connecting prose. Auto-summary concatenates the titles into what reads like one garbled compound title, cut off mid-word.
These show up as the broken preview text when the page URLs are shared on Slack/Twitter/LinkedIn, or as the snippet under a Google search result.
A number of other pages are also missing description: front matter (about.md, community/taps.md, community/_index.md, docs/contributing.md, docs/getting-started.md, docs/metadata.md, docs/project/_index.md, docs/security/reporting.md, docs/_index.md, resources/_index.md, search.md), but those bodies are real prose, so the auto-summary is merely inconsistent/off-message rather than visibly broken. Lower priority, but worth fixing at the same time for consistency with the pattern already used on docs/overview.md, docs/faq.md, spec.md, etc.
Suggested fix
Add an explicit description: field to front matter on each affected page, same pattern as PR #170.
Summary
Follow-up to #168. That issue found that pages without an explicit
description:front matter field fall back to Hugo's auto-generated.Summaryforog:description, which produces garbled text when a page's body is a list of short, disconnected fragments rather than prose. #168 / PR #170 fixed this for News and Adoptions, but the same root cause affects other pages that were not covered by that fix.Affected pages
content/en/docs/project/timeline.md— a list of**YEAR**: fragmententries (16 of them), same shape as the News page. Auto-summary truncates at ~70 words mid-entry, jamming unrelated years together, e.g.:content/en/docs/security/audits.md— a bare list of dated audit report links with trailing fragments ("covering PHP-TUF and Rugged", etc.). Auto-summary strips the links/bullets and runs the dates and fragments together into nonsense.content/en/resources/publications.md— a bare list of paper title links with no connecting prose. Auto-summary concatenates the titles into what reads like one garbled compound title, cut off mid-word.These show up as the broken preview text when the page URLs are shared on Slack/Twitter/LinkedIn, or as the snippet under a Google search result.
A number of other pages are also missing
description:front matter (about.md,community/taps.md,community/_index.md,docs/contributing.md,docs/getting-started.md,docs/metadata.md,docs/project/_index.md,docs/security/reporting.md,docs/_index.md,resources/_index.md,search.md), but those bodies are real prose, so the auto-summary is merely inconsistent/off-message rather than visibly broken. Lower priority, but worth fixing at the same time for consistency with the pattern already used ondocs/overview.md,docs/faq.md,spec.md, etc.Suggested fix
Add an explicit
description:field to front matter on each affected page, same pattern as PR #170.