google/comprehensive-rust

Add structured data to generated pages

Open

#1,142 opened on Aug 31, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (32,954 stars) (2,009 forks)batch import
enhancementgood first issuehelp wanted

Description

We should look into adding structured data to the generated HTML.

I imagine this could be metadata about each page:

  • title, though this is probably covered fine with the title element,
  • when was the page last changed (look this up in Git),
  • place in the page hierarchy,

It seems there is special vocabulary available which might be interesting for us:

How to do this? Likely with a new mdbook preprocessor which can inject the data into the publishing pipeline.

Contributor guide

Tech stack
rusthtml
Domain
documentationperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingmdbook knowledgeStructured data basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Explore existing mdbook preprocessors to understand the API and how to inject JSON LD into the generated HTML. Look at the mdbook documentation for creating custom preprocessors. Consider the specific structured data types mentioned: Breadcrumb, Course, SitelinksSearchBox. Test with a simple preprocessor that adds a static JSON LD block to verify the pipeline works, then implement dynamic data extraction (e.g., page hierarchy, last modified date from Git). The issue has one comment that may provide additional guidance.