Skip to content

Commit

Permalink
Merge pull request #771 from dbrumann/update_docs
Browse files Browse the repository at this point in the history
Fix link warnings
  • Loading branch information
Denis Brumann authored Dec 22, 2021
2 parents dbebbf3 + 50ff40c commit 2171d2a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ the *Controller* layer.

As we defined our layers, we can generate a dependency graph for the example
configuration:
(Make sure that [*Graphviz*](../README.md#optional-dependency-graphviz) (dot) is
(Make sure that [*Graphviz*](/#optional-dependency-graphviz) (dot) is
installed on your system)

```bash
Expand All @@ -90,7 +90,7 @@ php deptrac.phar analyse --config-file=examples/ModelController1.depfile.yaml

After Deptrac has finished, an image should be opened:

![ModelController1](../examples/ModelController1.png)
![ModelController1](examples/ModelController1.png)

On your command line Deptrac will produce this output:

Expand Down Expand Up @@ -169,7 +169,7 @@ any of the two other layers.

After running Deptrac we will get this result:

![ModelController1](../examples/ControllerServiceRepository1.png)
![ModelController1](examples/ControllerServiceRepository1.png)

```bash
Start to create an AstMap for 3 Files.
Expand Down Expand Up @@ -275,7 +275,7 @@ examples\MyNamespace\Controllers\SomeController::9 must not depend on examples\M
Found 2 Violations
```

![ModelController1](../examples/ModelController2.png)
![ModelController1](examples/ModelController2.png)

Deptrac has found two violations because the relation from the controller to
model layers is not allowed. The console output shows exactly the lines Deptrac
Expand Down
2 changes: 1 addition & 1 deletion docs/depfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ parameters:

The resulting output will look like this:

![GraphvizGroups](../examples/GraphvizGroups.png)
![GraphvizGroups](examples/GraphvizGroups.png)

##### `hidden_layers`

Expand Down
2 changes: 1 addition & 1 deletion docs/formatters.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ parameters:

Will produce the following graph:

![GraphvizGroups](../examples/GraphvizGroups.png)
![GraphvizGroups](examples/GraphvizGroups.png)

#### Pointing to groups instead of nodes
With `formatters.graphviz.pointToGroups` set to `true`, when you have a node inside a groups with the same name as the group itself, edges pointing to that node will point to the group instead. This might be useful for example if you want to provide a "public API" for a module defined by a group.
Expand Down

0 comments on commit 2171d2a

Please sign in to comment.