google/comprehensive-rust

Cleaner URLs

Open

#1.227 geöffnet am 21. Sept. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (2.009 Forks)batch import
good first issuehelp wanted

Repository-Metriken

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

Beschreibung

See if we can make https://github.com/rust-lang/mdBook/issues/1563 happen somehow. There are several options for this:

  • Help upstream implement this (preferred)
  • Implement it ourselves by post-processing the generated HTML.

Post-processing the HTML could perhaps even be done using a new template engine (https://github.com/google/mdbook-i18n-helpers/issues/70). It would require us to assign the rendered Markdown ({{{ content }}} in handlebars) to a variable or block and then filter it somehow.

Contributor Guide

Research-Richtung
Untersuche, wie mdBook URLs generiert, und erkunde Optionen, um sie sauberer zu machen: entweder durch einen Beitrag zum upstream mdBook Projekt oder durch Nachbearbeitung des generierten HTML mit einer Template Engine.
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.
1-2 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.
Klar
Voraussetzungen
RustmdBook
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45