From fae92b072ec75af99134184be67b649ba8e44eee Mon Sep 17 00:00:00 2001
From: mpl <mathieu.lonjaret@gmail.com>
Date: Wed, 12 Apr 2017 16:28:09 +0200
Subject: [PATCH] app/scanningcabinet: add go doc

Change-Id: I7076e0777a10675b0cf1ae5ed86e473dad148c46
---
 app/scanningcabinet/main.go         | 17 +++++++++++++++++
 doc/release/monthly/2017-03-01.html |  2 +-
 doc/release/monthly/2017-04-05.html |  2 +-
 3 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/app/scanningcabinet/main.go b/app/scanningcabinet/main.go
index 10cc2e476..d1a1c1d81 100644
--- a/app/scanningcabinet/main.go
+++ b/app/scanningcabinet/main.go
@@ -14,6 +14,23 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// The scanning cabinet program is a server application to store scanned
+// documents in Camlistore, and to manage them. It is a port of the
+// application originally created by Brad Fitzpatrick:
+// https://github.com/bradfitz/scanningcabinet.
+//
+// The data schema is roughly as follows:
+//
+// A scan is a permanode, with the node type: "scanningcabinet:scan". A scan's
+// camliContent attribute is set to the actual image file. A scan also holds the
+// "dateCreated" attribute, as well as the "document" attribute, which references
+// the document this scan is a part of (if any).
+//
+// A document is a permanode, with the node type: "scanningcabinet:doc".
+// A document page, is modeled by the "camliPath:sha1-xxx" = "pageNumber" relation,
+// where sha1-xxx is the blobRef of a scan. A document can also hold the following
+// attributes: "dateCreated", "tag", "locationText", "title", "startDate", and
+// "paymentDueDate".
 package main
 
 import (
diff --git a/doc/release/monthly/2017-03-01.html b/doc/release/monthly/2017-03-01.html
index 82ca1fdd1..0d56f0114 100755
--- a/doc/release/monthly/2017-03-01.html
+++ b/doc/release/monthly/2017-03-01.html
@@ -17,7 +17,7 @@ https://df4a6661.camlistore.net.
 </p>
 
 <p id="scanningcabinet">
-Another notable addition, albeit experimental as well, is the <b>Scanning Cabinet</b>
+Another notable addition, albeit experimental as well, is the <a href='/app/scanningcabinet'>Scanning Cabinet</a>
 app, a <a href='https://camlistore.googlesource.com/camlistore/+/5a24ffd85429b3b39049358625f7a75007a40b23'>port</a>
 of <a href='https://github.com/bradfitz/scanningcabinet'>bradfitz/scanningcabinet</a>.
 </p>
diff --git a/doc/release/monthly/2017-04-05.html b/doc/release/monthly/2017-04-05.html
index a1a60f93a..867e823f3 100755
--- a/doc/release/monthly/2017-04-05.html
+++ b/doc/release/monthly/2017-04-05.html
@@ -19,7 +19,7 @@ is limited to one item, but these limitations should be addressed soon.
 
 <p>
 Other notable changes for this release are improvements to the
-<a href='/doc/release/monthly/2017-03-01.html#scanningcabinet'>scanning cabinet</a>,
+<a href='/app/scanningcabinet'>scanning cabinet</a>,
 especially to its web user interface, and the introduction of a new
 importer for <a href="https://plaid.com">Plaid</a>, for financial transactions.
 </p>