Skip to content

Commit

Permalink
update architecture diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
zainhoda committed Mar 21, 2023
1 parent 1d3bfeb commit bc41eb1
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to PyVibe

## Architecture
`generate.swift`, `generate.py`, and `pdoc` are executed. Everything else is either an input or an output
The [`generator`](generator) directory contains the source assets. Everything else is generated from there.

```mermaid
---
Expand All @@ -12,9 +12,10 @@ flowchart TD
generate.swift --> spec(spec/spec.json)
generate.swift --> init(src/__init__.py)
spec --> generate.py[[generator/generate.py]]
generate.py --> reference(docs/reference.html)
init --> pdoc[[pdoc]]
pdoc --> pyvibe.html(docs/pyvibe.html)
generate.py --> docs_html(docs/*.html)
generate.py --> gallery_html(docs/gallery/*.html)
gallery_html --> screenshot.py[[screenshot.py]]
screenshot.py --> img(img/*.png)
```

Due to the architecture above, pull requests should be submitted only to files in the `/generator` subdirectory since everything else is generated from those files
Expand Down

0 comments on commit bc41eb1

Please sign in to comment.