Merge pull request #16 from kamangir/doc-refactors-2025-01-07-MSv2B7

doc refactors
kamangir · Jan 8, 2025 · 7ca03e5 · 7ca03e5
2 parents c748c37 + ccf3d97
commit 7ca03e5
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -7,22 +7,35 @@
 pip install vancouver-watching
 ```
 
-```bash
-@select
-vanwatch ingest \
-	area=vancouver,count=4 . \
-	detect,gif,publish
-@open QGIS .
-```
-
 |   |   |
 | --- | --- |
-| [time-series](https://kamangir-public.s3.ca-central-1.amazonaws.com/vanwatch-cache-2024-02-28-21-04-19-26236.tar.gz) [![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/2024-01-06-20-39-46-73614/2024-01-06-20-39-46-73614-2X.gif?raw=true&random=Uwwn5uFdCR4zYyFi)](https://kamangir-public.s3.ca-central-1.amazonaws.com/vanwatch-cache-2024-02-28-21-04-19-26236.tar.gz) | [last build](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true&random=7S1KaBb4D69pBS2I) [![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true&random=t0pJcXA6uS6Y62Ha)](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true&random=7S1KaBb4D69pBS2I) |
+| [time-series](https://kamangir-public.s3.ca-central-1.amazonaws.com/vanwatch-cache-2024-02-28-21-04-19-26236.tar.gz) [![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/2024-01-06-20-39-46-73614/2024-01-06-20-39-46-73614-2X.gif?raw=true&random=66CV8DBS58wK4vBt)](https://kamangir-public.s3.ca-central-1.amazonaws.com/vanwatch-cache-2024-02-28-21-04-19-26236.tar.gz) | [last build](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true&random=7VR3mIrfAnsllYCa) [![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true&random=4FIOfqq4RBDT8fjA)](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true&random=7VR3mIrfAnsllYCa) |
+
+
+```mermaid
+graph LR
+    discover["vanwatch<br>discover<br>target=&lt;target&gt;<br>&lt;object-name&gt;"]
+    object1["geojson"]:::folder
+    ingest["vanwatch<br>ingest<br>target=&lt;target&gt;<br>&lt;object-name&gt;"]
+    detect["vanwatch<br>detect<br>gif,publish<br>&lt;object-name&gt;"]
+    ingest_detect["vanwatch<br>ingest<br>target=&lt;target&gt;<br>&lt;object-name&gt;<br>detect,gif,publish"]
+    object2["geojson"]:::folder
+
+    discover --> object1
+    object1 -- "#tag" --> ingest
+    object1 -- "#tag" --> ingest_detect
+    ingest --> object2
+    ingest_detect --> object2
+    object2 --> detect
+    detect --> object2
+
+    classDef folder fill:#999,stroke:#333,stroke-width:2px;
+```
 
 ---
 
 
 [![pylint](https://github.com/kamangir/vancouver-watching/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/vancouver-watching/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/vancouver-watching/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/vancouver-watching/actions/workflows/pytest.yml) [![bashtest](https://github.com/kamangir/vancouver-watching/actions/workflows/bashtest.yml/badge.svg)](https://github.com/kamangir/vancouver-watching/actions/workflows/bashtest.yml) [![PyPI version](https://img.shields.io/pypi/v/vancouver-watching.svg)](https://pypi.org/project/vancouver-watching/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/vancouver-watching)](https://pypistats.org/packages/vancouver-watching)
 
-built by 🌀 [`blue_options-4.175.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌈 [`vancouver_watching-3.476.1`](https://github.com/kamangir/vancouver-watching).
+built by 🌀 [`blue_options-4.175.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌈 [`vancouver_watching-3.488.1`](https://github.com/kamangir/vancouver-watching).
 
diff --git a/template.md b/template.md
@@ -7,16 +7,29 @@
 pip install vancouver-watching
 ```
 
-```bash
-@select
-vanwatch ingest \
-	area=vancouver,count=4 . \
-	detect,gif,publish
-@open QGIS .
-```
-
 --table--
 
+
+```mermaid
+graph LR
+    discover["vanwatch<br>discover<br>target=&lt;target&gt;<br>&lt;object-name&gt;"]
+    object1["geojson"]:::folder
+    ingest["vanwatch<br>ingest<br>target=&lt;target&gt;<br>&lt;object-name&gt;"]
+    detect["vanwatch<br>detect<br>gif,publish<br>&lt;object-name&gt;"]
+    ingest_detect["vanwatch<br>ingest<br>target=&lt;target&gt;<br>&lt;object-name&gt;<br>detect,gif,publish"]
+    object2["geojson"]:::folder
+
+    discover --> object1
+    object1 -- "#tag" --> ingest
+    object1 -- "#tag" --> ingest_detect
+    ingest --> object2
+    ingest_detect --> object2
+    object2 --> detect
+    detect --> object2
+
+    classDef folder fill:#999,stroke:#333,stroke-width:2px;
+```
+
 ---
 
 --signature--
diff --git a/vancouver_watching/__init__.py b/vancouver_watching/__init__.py
@@ -8,7 +8,7 @@
 
 DESCRIPTION = f"{ICON} Vancouver Watching with AI."
 
-VERSION = "3.476.1"
+VERSION = "3.488.1"
 
 REPO_NAME = "vancouver-watching"
 

diff --git a/vancouver_watching/help/discover.py b/vancouver_watching/help/discover.py
@@ -28,7 +28,7 @@ def help_discover(
             "[-|<object-name>]",
             "[<args>]",
         ],
-        "discover target -> <object-name>.",
+        "discover <target> -> <object-name>.",
         target_details,
         mono=mono,
     )
diff --git a/vancouver_watching/help/ingest.py b/vancouver_watching/help/ingest.py
@@ -1,7 +1,6 @@
 from typing import List
 
 from blue_options.terminal import show_usage, xtra
-from abcli.help.generic import help_functions as generic_help_functions
 
 from vancouver_watching.help.discover import target_details
 from vancouver_watching.help.detect import (