Skip to content

Commit

Permalink
docs(devtools): add video to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilmysliwiec committed Apr 3, 2023
1 parent e8547ef commit 95fba60
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
16 changes: 15 additions & 1 deletion content/devtools/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Once the `DevtoolsModule` is imported and your application is up and running (`n

<figure><img src="/assets/devtools/modules-graph.png" /></figure>

> info **Hint** As you can see on the screenshot above, every module connect to the `InternalCoreModule`. `InternalCoreModule` is a global module that is always imported into the root module. Since it's registered as a global node, Nest automatically creates edges between all of the modules and the `InternalCoreModule` node. Now, if you want to hide global modules from the graph, you can use the "Hide global modules" checkbox (in the sidebar).
> info **Hint** As you can see on the screenshot above, every module connects to the `InternalCoreModule`. `InternalCoreModule` is a global module that is always imported into the root module. Since it's registered as a global node, Nest automatically creates edges between all of the modules and the `InternalCoreModule` node. Now, if you want to hide global modules from the graph, you can use the "**Hide global modules**" checkbox (in the sidebar).
So as we can see, `DevtoolsModule` makes your application expose an additional HTTP server (on port 8000) that the Devtools application will use to introspect your app.

Expand All @@ -66,6 +66,20 @@ Using the form controls located in the sidebar (on the left), you can control ed

This can be particularly useful when you have **new developers** on your team and you want to show them how your application is structured. You can also use this feature to visualize a specific module (e.g. `TasksModule`) and all of its dependencies, which can come in handy when you're breaking down a large application into smaller modules (for example, individual micro-services).

You can watch this video to see the **Graph Explorer** feature in action:

<figure>
<iframe
width="800"
height="450"
src="https://www.youtube.com/embed/bW8V-ssfnvM"
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen
></iframe>
</figure>
#### Investigating the "Cannot resolve dependency" error

> info **Note** This feature is supported for `@nestjs/core` >= `v9.3.10`.
Expand Down
7 changes: 5 additions & 2 deletions src/styles.scss
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,14 @@ figure {
margin: 60px 0;
}

img {
img, iframe {
max-width: 100%;
height: auto;
box-shadow: 0 0 50px 0 rgba(0, 0, 0, 0.08);
}

img {
height: auto;
}
}

figcaption {
Expand Down

0 comments on commit 95fba60

Please sign in to comment.