rust-lang/mdbook

0

/ 100

Documentation85
Engineering96
Health86
Rust21,824MPL-2.05d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Create book from markdown files. Like Gitbook but implemented in Rust

Documentation

85

README12pt68

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MPL-2.0.

Contributing guide5pt100

Contributing guide is detailed and thorough.

Engineering

96

Reproducibility6pt70

Lockfile present (Cargo.lock). Installs are reproducible.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/main.yml).

Linting and formatting5pt100

Linter or formatter configured (eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

86

Dependency manifest6pt55

Dependency manifest found (Cargo.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files22 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Issue or PR templates present.
  • ci
  • crates
  • examples
  • guide
  • src
  • tests
    Good: Test files detected (tests).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • LICENSE
    Good: Licensed under MPL-2.0.
  • package.json
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rustfmt.toml
  • triagebot.toml