📝 [skip actions] update doc

anucvml · Mar 12, 2022 · 1713bc3 · 1713bc3
1 parent 25a12ed
commit 1713bc3
Show file tree

Hide file tree

Showing 21 changed files with 12 additions and 201 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,11 @@
 
 _An in-browser video annotation tool developed by [ANU CVML](https://github.com/anucvml)._
 
+[![Stable Release](https://img.shields.io/github/v/release/anucvml/vidat?sort=semver&label=Stable)](https://github.com/anucvml/vidat/releases)
+[![Latest Release](https://img.shields.io/github/v/release/anucvml/vidat?include_prereleases&label=Latest&sort=semver)](https://github.com/anucvml/vidat/releases)
+[![CD Status](https://github.com/anucvml/vidat/actions/workflows/cd.yaml/badge.svg)](https://github.com/anucvml/vidat/actions/workflows/cd.yaml)
+[![Star](https://img.shields.io/github/stars/anucvml/vidat?style=social)](https://github.com/anucvml/vidat)
+
 _[Host 1](https://users.cecs.anu.edu.au/~sgould/vidat2/)_
 | _[Host 2](https://vidat2.davidz.cn)_
 | _[Demo 1](https://users.cecs.anu.edu.au/~sgould/vidat2/?annotation=annotation/example.json)_
@@ -177,6 +182,8 @@ browsers.
 
 `auto` Vidat will determine which one to use for you.
 
+See [VideoLoader Wiki](https://github.com/anucvml/vidat/wiki/VideoLoader) for details.
+
 ### `showObjects`
 
 **Default** `true`
@@ -426,4 +433,8 @@ See [`src/public/annotation/example.json`](src/public/annotation/example.json) f
 
 ## Development
 
-See [`doc/design/main.md`](doc/design/main.md) [WIP] for details.
+See [Wiki](https://github.com/anucvml/vidat/wiki#further-development) for details.
+
+## Design
+
+See [Design Wiki](https://github.com/anucvml/vidat/wiki/Design) for details.
diff --git a/doc/design/app.md b/doc/design/app.md
diff --git a/doc/design/main.md b/doc/design/main.md
diff --git a/doc/design/pages/about.md b/doc/design/pages/about.md
diff --git a/doc/design/pages/annotation.md b/doc/design/pages/annotation.md
diff --git a/doc/design/pages/configuration.md b/doc/design/pages/configuration.md
diff --git a/doc/design/pages/help.md b/doc/design/pages/help.md
diff --git a/doc/design/pages/notfound.md b/doc/design/pages/notfound.md
diff --git a/doc/design/pages/preference.md b/doc/design/pages/preference.md
diff --git a/doc/img/ActionLabelTable.png b/doc/img/ActionLabelTable.png
diff --git a/doc/img/ObjectLabelTable.png b/doc/img/ObjectLabelTable.png
diff --git a/doc/img/SkeletonTypePreview.png b/doc/img/SkeletonTypePreview.png
diff --git a/doc/img/SkeletonTypeTable.png b/doc/img/SkeletonTypeTable.png
diff --git a/doc/img/about.png b/doc/img/about.png
diff --git a/doc/img/annotation-sections.png b/doc/img/annotation-sections.png
diff --git a/doc/img/annotation.png b/doc/img/annotation.png
diff --git a/doc/img/app.png b/doc/img/app.png
diff --git a/doc/img/configuration.png b/doc/img/configuration.png
diff --git a/doc/img/help.png b/doc/img/help.png
diff --git a/doc/img/notfound.png b/doc/img/notfound.png
diff --git a/doc/img/preference.png b/doc/img/preference.png