API doc lists explicit clickable examples; fixes #66

bast · Oct 18, 2018 · 000ac20 · 000ac20
1 parent 1cabd72
commit 000ac20
Showing 1 changed file with 3 additions and 7 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -12,9 +12,7 @@ This API is the future::
 
   /v3/<engine>/<engine_version>/<repo>/<branch>/<path>/
 
-Example:
-
-  /v3/remark/0.14.0/github.com/bast/cicero/master/demo/talk.md
+Example: https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/talk.md/
 
 
 v2
@@ -24,14 +22,12 @@ This API is currently the default::
 
   /v2/remark/github/<namespace>/<repo>/<branch>/<path>/
 
-Example:
-
-  /v2/remark/github/bast/cicero/master/demo/talk.md
+Example: https://cicero.xyz/v2/remark/github/bast/cicero/master/demo/talk.md
 
 
 v1
 ==
 
-This API is deprecated but supported::
+This API is deprecated since it does not allow talks in subdirectories::
 
   /v1/github/<namespace>/<repo>/<branch>/<path>/remark/