Skip to content

Commit

Permalink
docs(console): update screenshots in README (#419)
Browse files Browse the repository at this point in the history
The screenshots in the README, which are also used in in the
`tokio-console` page on docs.rs were a bit outdated. The UI has changed
a bit since they were created.

This change updates the screenshots to be based on the latest UI from
the `main` branch.
  • Loading branch information
hds authored and hawkw committed Sep 29, 2023
1 parent b18ee47 commit e9bcd67
Show file tree
Hide file tree
Showing 12 changed files with 6 additions and 6 deletions.
Binary file removed assets/details1.png
Binary file not shown.
Binary file removed assets/details2.png
Binary file not shown.
Binary file removed assets/details2_crop.png
Binary file not shown.
Binary file removed assets/resource_details1.png
Binary file not shown.
Binary file removed assets/resource_details2.png
Binary file not shown.
Binary file added assets/resource_details_semaphore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/resource_details_sleep.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/resources.png
Binary file not shown.
Binary file added assets/resources_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/task_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/tasks_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions tokio-console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,14 @@ Using the <kbd>&#8593;</kbd> and <kbd>&#8595;</kbd> arrow keys, an individual ta
Pressing<kbd>enter</kbd> while a task is highlighted displays details about that
task:

![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/details2.png)
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/task_details.png)

Pressing the <kbd>escape</kbd> key returns to the task list.

The <kbd>r</kbd> key switches from the list of tasks to a list of [resources],
such as synchronization primitives, I/O resources, et cetera:

![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resources.png)
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resources_list.png)


Pressing the <kbd>t</kbd> key switches the view back to the task list.
Expand All @@ -122,13 +122,13 @@ Like the task list view, the resource list view can be navigated using the
<kbd>&#8593;</kbd> and <kbd>&#8595;</kbd> arrow keys. Pressing <kbd>enter</kbd>
while a resource is highlighted displays details about that resource:

![resource details --- oneshot](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details1.png)
![resource details --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details_sleep.png)

The resource details view lists the tasks currently waiting on that resource.
This may be a single task, as in the [`tokio::sync::oneshot`] channel above, or
a large number of tasks, such as this [`tokio::sync::Semaphore`]:
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`:

![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details2.png)
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details_semaphore.png)

Like the task details view, pressing the <kbd>escape</kbd> key while viewing a resource's details
returns to the resource list.
Expand Down

0 comments on commit e9bcd67

Please sign in to comment.