Skip to content

Commit e1a67f5

Browse files
committed
Update diagram readme doc with corrected paths
1 parent 182ceca commit e1a67f5

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎docs/assets/diagrams/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Install steps are included in the main [README.md](../../../README.md) file, or
1111

1212
There are several examples within this folder, though the Diagram site has a [Quick Start](https://diagrams.mingrammer.com/docs/getting-started/installation#quick-start) guide and [Examples](https://diagrams.mingrammer.com/docs/getting-started/examples) page, which formed the basis for our existing diagrams in this documentation.
1313

14-
Custom icons are typically stored in `/assets`, though the Diagrams site provides an [example](https://diagrams.mingrammer.com/docs/getting-started/examples#rabbitmq-consumers-with-custom-nodes) of how to do this via `urllib.request`. Some websites block direct downloads using `urllib` and cause a 403 Forbidden error, and so it is preferable to keep custom icons within this repository.
14+
Custom icons are typically stored in `/docs/images/architecture/icons`, though the Diagrams site provides an [example](https://diagrams.mingrammer.com/docs/getting-started/examples#rabbitmq-consumers-with-custom-nodes) of how to do this via `urllib.request`. Some websites block direct downloads using `urllib` and cause a 403 Forbidden error, and so it is preferable to keep custom icons within this repository.
1515

1616
## Generating a Diagram
1717
To generate a new diagram, run the following command in a working directory:
@@ -20,4 +20,4 @@ To generate a new diagram, run the following command in a working directory:
2020
python <diagram_name>.py
2121
```
2222

23-
The image will be saved in the same working directory, its name depending on the value of `with Diagram(filename="main_network")` value in the `<diagram_name>.py` file.
23+
Diagrams are typically found in the `/docs/images/architecture` directory. The path/filename is set by the `with Diagram(filename="...")` value in a `<diagram_name>.py` file.

0 commit comments

Comments
 (0)