google/comprehensive-rust

Cleaner URLs

Open

#1,227 opened on Sep 21, 2023

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

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (Avg merge 9d 23h) (36 merged PRs in 30d)

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

Research direction
Investigate how mdBook generates URLs and explore options to make them cleaner: either by contributing to the upstream mdBook project or by post processing the generated HTML using a template engine.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustmdBook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45