freeCodeCamp/devdocs

Support Tokio documentation

Open

#2,691 opened on Jun 1, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Ruby (2,598 forks)batch import
docs/new+requesthelp wanted

Repository metrics

Stars
 (38,907 stars)
PR merge metrics
 (Avg merge 30d 13h) (8 merged PRs in 30d)

Description

Feature request

Summary

Add support for the Tokio documentation set to DevDocs.

Tokio is the de facto asynchronous runtime for Rust and is one of the most widely used libraries in the Rust ecosystem. Many Rust developers spend a significant amount of time referencing Tokio's documentation alongside the Rust standard library, making it a strong candidate for inclusion in DevDocs.

Having Tokio available offline and searchable through DevDocs would improve the experience for developers building async applications, web services, networking tools, and distributed systems in Rust.

Examples

Official documentation:

Repository:

Commonly referenced modules and APIs:

  • tokio::spawn
  • tokio::task
  • tokio::sync
  • tokio::net
  • tokio::time
  • tokio::fs
  • tokio::process
  • tokio::select!

Why this would be valuable:

  • Tokio is the most popular async runtime in the Rust ecosystem.
  • It is a dependency of many widely used Rust frameworks and libraries, including Axum, Hyper, and Tonic.
  • Rust developers frequently need to search Tokio APIs while developing async applications.
  • Offline access through DevDocs would make Rust development more productive and reduce context switching between multiple documentation sites.

Contributor guide

Research direction
Review the existing documentation source adding guide in DevDocs. Understand the scraping and indexing pipeline. Investigate how other Rust documentation sets (e.g., std) are integrated. Identify the Tokio crate's documentation structure on docs.rs and decide on the scraping approach (e.g., using the Rust doc JSON format or HTML scraping). Implement the new source in the appropriate file(s) following the pattern of existing sources.
Tech stack
rubyrust
Domain
documentation
Issue type
Feature
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
RubyGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60