docs: improve upstream `md-book` code snippets display · FuelLabs/fuels-rs#388

(0 comments) (1 reaction) (1 assignee)Rust (43,211 stars) (1,360 forks)batch import

blockedenhancementgood first issue

Description

We now want all code that goes in the book to be tested (and put in the examples directory), so all code in The Book will soon be put there using the {{include path/to/file}} tag of md-book.

Problem: the formatting isn 't very nice, there's extra identation displayed because the code is inside a test function.

Fixing https://github.com/rust-lang/mdBook/issues/1601 would solve this! It would also be of benefit for all books!

Tagging @mitchmindtree for tooling consideration :smile:

Tech stack: rust
Domain: documentation
Issue type: documentation
Difficulty: 3
Estimated time: 1-2 days
Activity status: blocked
Clarity: mostly clear
Prerequisites: Rust basicsmdBookHTML/CSS fundamentals
Newbie friendliness: 40
Research direction: Investigate the linked upstream issue (rust lang/mdBook#1601) to understand the proposed fix for code snippet indentation. Explore the `examples` directory in fuels rs and the mdBook configuration files (e.g., book.toml) to see how the include macro is currently used. Implement a workaround or contribute to the upstream fix to strip extra indentation from included code snippets. Check the assignee's comments for any prior work or direction.