Skip to content

Commit

Permalink
docs(console): revert "update screenshots in README (#419)"
Browse files Browse the repository at this point in the history
This reverts commit 4f71484. This
commit breaks the existing docs, because it deletes images that are
linked in the current `docs.rs` documentation for `tokio-console`. Also,
we probably ought to resize the images so the text doesn't get scaled.

In the future, when adding new screenshots, let's make sure not to
delete the existing ones, because their GitHub URLs are referenced by
prior versions of the docs (cc @hds).

We should probably figure out a nicer image hosting solution
eventually...
  • Loading branch information
hawkw committed Sep 29, 2023
1 parent e9bcd67 commit 993a3d9
Show file tree
Hide file tree
Showing 12 changed files with 6 additions and 6 deletions.
Binary file added assets/details1.png
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/details2.png
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/details2_crop.png
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_details1.png
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_details2.png
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/resource_details_semaphore.png
Binary file not shown.
Binary file removed assets/resource_details_sleep.png
Binary file not shown.
Binary file added assets/resources.png
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_list.png
Binary file not shown.
Binary file removed assets/task_details.png
Binary file not shown.
Binary file modified assets/tasks_list.png
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
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/task_details.png)
![task details](https://raw.githubusercontent.com/tokio-rs/console/main/assets/details2.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_list.png)
![resource list](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resources.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 --- sleep](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details_sleep.png)
![resource details --- oneshot](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details1.png)

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`:
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`]:

![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details_semaphore.png)
![resource details --- semaphore](https://raw.githubusercontent.com/tokio-rs/console/main/assets/resource_details2.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 993a3d9

Please sign in to comment.