Skip to content

Add page descriptions, link previews and canonical links - #208

Open
bendichter wants to merge 12 commits into
mainfrom
seo-metadata
Open

bendichter wants to merge 12 commits into
mainfrom
seo-metadata

Conversation

@bendichter

Copy link
Copy Markdown
Contributor

Combines four PRs about how pages appear in search results and link previews. Each one is a separate merge commit, so they can be reviewed one at a time.

  • Add descriptions to pages that have none (#197, approved there by @oruebel): a one or two sentence description in the front matter of 23 pages, drawn from text already on each page. The wording is the part to review.
  • Add description and link preview metadata to every page (#196): a partial that writes the meta description, Open Graph tags and Twitter card type, reading the descriptions above and falling back to the page body or a site-wide default.
  • Add a canonical link to every page (#198): points search engines at the nwb.org address rather than nwborg.netlify.app. The paginated news list is left without one.
  • Stop building tag and category pages (#201): disables the taxonomy page kinds, which removes eight unlinked pages from the site and the sitemap. Tags still display on news posts.

The combined branch builds with Hugo 0.152.2 and produces 157 pages, the 165 on main less the eight taxonomy pages. pr_link_check failed on #197, so it may fail here too.

Supersedes #196, #197, #198 and #201.

🤖 Generated with Claude Code

bendichter and others added 11 commits October 9, 2026 14:46
These 23 pages have no `description`, `summary` or `subtitle` in their
front matter. Most keep their text in nested front matter sections and
have an empty body, so there is nothing to derive a description from.
Each description here is drawn from text already on the page.

No template renders the field on these pages, so the built site is
unchanged by this commit alone. The metadata partial reads it for the
meta description and for link previews.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Pages had no meta description and no Open Graph tags, so links shared in
Slack, Bluesky or LinkedIn showed no title, summary or image, and search
engines had to pick their own snippet.

The new partial takes the description from the `description`, `summary`
or `subtitle` front matter, then the start of the page body, then a
site-wide default in hugo.yaml. The preview image is the page's `image`
when it is a PNG or JPEG no wider than 3.3:1, and a default card
otherwise. The default card is the Zoom background from the branding
page cropped to 1200x630.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The Netlify production build serves a second, indexable copy of the site
at nwborg.netlify.app, and pages can also be linked with tracking
parameters. A canonical link tells search engines that the nwb.org
address is the one to index.

The paginated news list is left out. Hugo gives every page of that list
the same `.Permalink`, so a canonical link there would point page 2 at
page 1.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Each news post stores its tags as one comma-separated string, so Hugo
builds one page per post under names like
/tags/announcement-software-pynwb-release/. These pages and the /tags/
and /categories/ indexes use the bare default list template, nothing
links to them, and all eight are in the sitemap.

Disabling the taxonomy kinds removes them. The tags shown on each news
post come from the front matter directly and are unaffected.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The site already has config/_default/params.yaml for the logo and the
header button. The two new parameters belong there, not in a second
`params` block in hugo.yaml. The built site is unchanged.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for nwborg ready!

Name Link
🔨 Latest commit a4d3d60
🔍 Latest deploy log https://app.netlify.com/projects/nwborg/deploys/6acebad3a731d00a4b027fbc
😎 Deploy Preview https://deploy-preview-208--nwborg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@bendichter

Copy link
Copy Markdown
Contributor Author

Before and after

"Before" is the production site and "after" is this PR's Netlify deploy preview, both at 1440 px wide.

/tags/: the unstyled list that overlapped the header is no longer built

Before After
before after

Default link preview image

The description, Open Graph and canonical tags are not visible on a page. This is the image a link preview shows for a page that has no suitable image of its own:

share card

The home page on production has no description, Open Graph, Twitter card or canonical tags. On the preview it has:

<meta name=description content="Neurodata Without Borders (NWB) is a data standard and software ecosystem for neurophysiology and behavioral data.">
<meta property="og:site_name" content="Neurodata Without Borders">
<meta property="og:title" content="Neurodata Without Borders">
<meta property="og:description" content="Neurodata Without Borders (NWB) is a data standard and software ecosystem for neurophysiology and behavioral data.">
<meta property="og:url" content="https://deploy-preview-208--nwborg.netlify.app/">
<meta property="og:image" content="https://deploy-preview-208--nwborg.netlify.app/images/share-card.jpg">
<meta property="og:type" content="website">
<meta name=twitter:card content="summary_large_image">
<link rel=canonical href=https://deploy-preview-208--nwborg.netlify.app/>

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

2 participants