Skip to content

docs: add SEO metadata and page descriptions - #115

Merged
BoxBoxJason merged 1 commit into
mainfrom
claude/lucid-fermi-jpeb2t
Oct 31, 2026
Merged

BoxBoxJason merged 1 commit into
mainfrom
claude/lucid-fermi-jpeb2t

Conversation

@BoxBoxJason

@BoxBoxJason BoxBoxJason commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Summary

Search and link preview metadata for https://boxboxjason.github.io/achievements/.

  • Site metadata (docs/hugo.toml): a home page description, a social preview card (docs/static/images/social.png, 1200x630, rendered with hugo-theme's tools/social-card.mjs), and project structured data: repository, MIT license, TypeScript, Visual Studio Code. A static mount was added, since this site lists its mounts explicitly.
  • Page descriptions: every page has a specific description of 50 to 160 characters. The generated Commands, Settings and Achievements catalogue pages get theirs from scripts/generate-docs.ts, so npm run docs:check still covers them.
  • Theme: pinned to hugo-theme b0b7836 on main, in both docs/go.mod and the workflow. It adds:
    • JSON-LD: SoftwareSourceCode on the home page, TechArticle on the other pages;
    • a robots.txt pointing at the sitemap;
    • the other projects in the footer;
    • a docs workflow check that fails when a page has no description.
  • Packaging is unchanged: docs/static is not in the VSIX (npm pack --dry-run).

Test plan

  • npm run check-types, npm run lint and npm run docs:check pass. docs:check fails when a generated description is edited by hand.
  • The theme's description check passes, with no length warnings.
  • The site builds with --panicOnWarning. The home and page <meta name="description"> tags are the written ones; og:image and twitter:image resolve under /achievements/; the JSON-LD parses.
  • All 275 internal links and anchors were checked with a script, with 0 problems. The panel GIF and the social card are both served.
  • The docs workflow passes on this PR.

- Site description, social preview card and project structured data (repository, MIT license, TypeScript, VS Code).
- A search-friendly description on every page; the generated commands, settings and catalogue pages get theirs from scripts/generate-docs.ts.
- Pin the shared hugo-theme to b0b7836, which adds JSON-LD, robots.txt with the sitemap and the page description check.
@BoxBoxJason
BoxBoxJason merged commit e6b6e11 into main Oct 31, 2026
6 checks passed
@BoxBoxJason
BoxBoxJason deleted the claude/lucid-fermi-jpeb2t branch October 31, 2026 10:53
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