google/comprehensive-rust

Cleaner URLs

Open

#1,227 opened on Sep 21, 2023

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

Description

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

Tech stack
rust
Domain
documentation
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Rust basicsmdBook knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate upstream issue rust lang/mdBook#1563 for cleaner URL support. If not feasible, explore post processing generated HTML using a template engine like discussed in google/mdbook i18n helpers#70. The goal is to modify the build pipeline to transform the rendered content ( content variable in Handlebars) to produce cleaner URLs. Check the mdBook documentation and the repository's build scripts to understand the current URL structure.