miniblog.

← Back to all posts
Sep 6, 2021 at 07:38
mdbook is a popular tool for Rust projects to document how they work: https://github.com/rust-lang/mdBook/ I suspect the name really helps: "writing a book" sounds much more impressive than "writing some docs"!
GitHub - rust-lang/mdBook: Create book from markdown files. Like Gitbook but implemented in Rust
GitHub - rust-lang/mdBook: Create book from markdown files. Like Gitbook but implemented in Rust
Create book from markdown files. Like Gitbook but implemented in Rust - rust-lang/mdBook

Related Posts

Jul 31, 2026 at 08:45
I carefully document `cargo install --locked` for difftastic users, I carefully use `--locked` for CI, and I've just realised that all my release builds totally ignore it! Oops. Anyone using my prebuilt binaries have been getting different Unicode width calculations in display.
Aug 18, 2024 at 23:45
I'm a huge fan of Swift's 'Error Handling Rationale' design document: https://github.com/swiftlang/swift/blob/9315673c003875158852579bd1f33480cdec5461/docs/ErrorHandlingRationale.md#fundamentals It carefully defines terminology and compares with other languages, so you can understand Swift's position and preference in the design space.
swift/docs/ErrorHandlingRationale.md at 9315673c003875158852579bd1f33480cdec5461 · swiftlang/swift
swift/docs/ErrorHandlingRationale.md at 9315673c003875158852579bd1f33480cdec5461 · swiftlang/swift
The Swift Programming Language. Contribute to swiftlang/swift development by creating an account on GitHub.
Feb 21, 2024 at 07:25
Fun example of a bunch of YAML gotchas all in a single file:
The yaml document from hell
As a data format, yaml is extremely complicated and it has many footguns. In this post I explain some of those pitfalls by means of an example, and I suggest a few simpler and safer yaml alternatives.