google/comprehensive-rust

Look at mdbook-keeper

Open

#175 opened on Jan 17, 2023

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

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

Tech stack
rust
Domain
developer experiencetoolingtesting
Issue type
research
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
basic Rust knowledgefamiliarity with mdbook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Evaluate the mdbook keeper tool (https://github.com/tfpk/mdbook keeper) as a replacement for the current compile fail code blocks in the comprehensive rust course. Focus on how it handles third party crates in code snippets, compare its setup and limitations with the existing mdbook test approach, and document findings. Look at the existing compile fail blocks in the repository to understand the scope. Discuss in the issue thread any questions or blockers identified during evaluation.