google/comprehensive-rust

Look at mdbook-keeper

Open

#175 opened on Jan 17, 2023

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

Repository metrics

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

Description

We currently have a number of code blocks marked with compile_fail: this is often because they depend on third-party crates which aren't available when running mdbook test.

We should look into using https://github.com/tfpk/mdbook-keeper/ to handle testing instead. It explicitly supports using third-party crates in code snippets.

Contributor guide

Research direction
Investigate mdbook keeper tool, understand its integration with mdbook, and propose how to replace compile fail code blocks with tested snippets using third party crates.
Tech stack
rust
Domain
documentationtesting
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
60