diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index d83bc78bc..913baddb6 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -101,6 +101,40 @@ jobs:
- name: Run cargo clippy
run: cargo clippy --workspace --all-targets --no-deps -- -D warnings
+ docs:
+ name: Docs
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout sources
+ uses: actions/checkout@v4
+
+ - name: Install stable toolchain
+ uses: dtolnay/rust-toolchain@master
+ with:
+ toolchain: stable
+ - uses: Swatinem/rust-cache@v2
+
+ - name: Docs.rs
+ env:
+ RUSTDOCFLAGS: >
+ -D warnings
+ --force-warn rustdoc::redundant-explicit-links
+ --force-warn renamed-and-removed-lints
+ --cfg docsrs
+ --cfg tokio_unstable
+ RUSTFLAGS: --cfg tokio_unstable
+ run: cargo doc --no-deps --all-features
+
+ run:
+ - name: Check tokio-console README images
+ run: >
+ for filename in
+ $(grep 'https://raw.githubusercontent.com/tokio-rs/console/main/assets' tokio-console/ README.md
+ | perl -n -e '/(tokio-console-[\d\.]+\/\w+\.png)/; print "$1\n"'
+ ); do
+ ls -l assets/$filename;
+ done
+
grpc_web:
name: gRPC-web Example
runs-on: ubuntu-latest
diff --git a/assets/readme/task-details.png b/assets/readme/task-details.png
index 6a527b345..9810ed766 100644
Binary files a/assets/readme/task-details.png and b/assets/readme/task-details.png differ
diff --git a/assets/readme/top-for-tasks.png b/assets/readme/top-for-tasks.png
index 4d6c56b8e..fab9fd481 100644
Binary files a/assets/readme/top-for-tasks.png and b/assets/readme/top-for-tasks.png differ
diff --git a/assets/tokio-console-0.1.13/resource_details_semaphore.png b/assets/tokio-console-0.1.13/resource_details_semaphore.png
new file mode 100644
index 000000000..f04a0dae6
Binary files /dev/null and b/assets/tokio-console-0.1.13/resource_details_semaphore.png differ
diff --git a/assets/tokio-console-0.1.13/resource_details_sleep.png b/assets/tokio-console-0.1.13/resource_details_sleep.png
new file mode 100644
index 000000000..591dca469
Binary files /dev/null and b/assets/tokio-console-0.1.13/resource_details_sleep.png differ
diff --git a/assets/tokio-console-0.1.13/resources_list.png b/assets/tokio-console-0.1.13/resources_list.png
new file mode 100644
index 000000000..a5d5aeb3e
Binary files /dev/null and b/assets/tokio-console-0.1.13/resources_list.png differ
diff --git a/assets/tokio-console-0.1.13/task_details.png b/assets/tokio-console-0.1.13/task_details.png
new file mode 100644
index 000000000..a0a7e8679
Binary files /dev/null and b/assets/tokio-console-0.1.13/task_details.png differ
diff --git a/assets/tokio-console-0.1.13/tasks_list.png b/assets/tokio-console-0.1.13/tasks_list.png
new file mode 100644
index 000000000..ba07ee2de
Binary files /dev/null and b/assets/tokio-console-0.1.13/tasks_list.png differ
diff --git a/tokio-console/README.md b/tokio-console/README.md
index 05e97074e..63102331f 100644
--- a/tokio-console/README.md
+++ b/tokio-console/README.md
@@ -121,7 +121,7 @@ tokio-console --lang en_US.UTF-8
When the console CLI is launched, it displays a list of all [asynchronous tasks]
in the program:
-
+
Tasks are displayed in a table.
@@ -154,7 +154,7 @@ task.
This view shows details about a specific task:
-
+
The task details view includes percentiles and a visual histogram of the polling (busy) times
and scheduled times.
@@ -166,7 +166,7 @@ Pressing the escape key returns to the task list.
The r key switches from the list of tasks to a list of [resources],
such as synchronization primitives, I/O resources, et cetera:
-
+
Resources are displayed in a table similar to the task list.
@@ -192,13 +192,13 @@ while a resource is highlighted displays details about that resource.
### Resource Details
-
+
The resource details view lists the tasks currently waiting on that resource.
This may be a single task, as in the [`tokio::time::Sleep`] above, or
a large number of tasks, such as this private `tokio::sync::batch_semaphore::Semaphore`:
-
+
The resource details view includes a table of async ops belonging to the resource.