https://github.com/statcan/aaw-developer-docs
Developer documentation for features of the AAW platform
https://github.com/statcan/aaw-developer-docs
Last synced: 8 months ago
JSON representation
Developer documentation for features of the AAW platform
- Host: GitHub
- URL: https://github.com/statcan/aaw-developer-docs
- Owner: StatCan
- Archived: true
- Created: 2022-08-22T14:27:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-27T17:06:44.000Z (over 2 years ago)
- Last Synced: 2025-03-27T05:42:13.023Z (12 months ago)
- Language: Makefile
- Homepage: https://statcan.github.io/aaw-developer-docs/
- Size: 6.08 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AAW Developer Documentation
Developer-facing documentation that covers the major features of the AAW platform.
# How to Contribute
## Update the Diagrams
Diagrams are created using the [Diagrams](https://diagrams.mingrammer.com/) Python package. To update the diagrams for this repo, simply run `make` at the root of the repository to find all `*.py` files and build the corresponding `*.png` file for each one.
## Develop a diagram
Create a new diagram with a unique name in the `/docs` folder.
Run the below `make target`
```
make dev/diagram_name
```
replacing `diagram_name` with the name of your new diagram (excluding the `.py` file extension).
This `make dev/diagram_name` will rebuild the diagram each time you save the corresponding python file.