google/comprehensive-rust

Add structured data to generated pages

Open

#1.142 geöffnet am 31. Aug. 2023

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Rust (2.009 Forks)batch import
enhancementgood first issuehelp wanted

Repository-Metriken

Stars
 (32.954 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 23h) (36 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuche vorhandene mdbook Präprozessoren, um die API und die Methode zum Einfügen von JSON LD in das generierte HTML zu verstehen. Sieh dir die mdbook Dokumentation zur Erstellung benutzerdefinierter Präprozessoren an. Berücksichtige die genannten spezifischen strukturierten Datentypen: Breadcrumb, Course, SitelinksSearchBox. Teste mit einem einfachen Präprozessor, der einen statischen JSON LD Block hinzufügt, um zu überprüfen, ob die Pipeline funktioniert, und implementiere dann die dynamische Datenextraktion (z. B. Seitenhierarchie, letztes Änderungsdatum aus Git). Das Issue hat einen Kommentar, der möglicherweise zusätzliche Anleitung bietet.
Tech Stack
rust
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Rustmdbook
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50