From 8d20886bd0638561ddd677a4e19a4f01022bdfde Mon Sep 17 00:00:00 2001
From: Eric Wong <normalperson@yhbt.net>
Date: Fri, 4 Apr 2014 23:28:53 +0000
Subject: doc: add design documentation for WWW interface

Mainly, start with URL routes since that's what users usually
see, first.
---
 Documentation/design_www.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 Documentation/design_www.txt

(limited to 'Documentation/design_www.txt')

diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
new file mode 100644
index 00000000..f6ed26a7
--- /dev/null
+++ b/Documentation/design_www.txt
@@ -0,0 +1,12 @@
+URL naming
+----------
+
+/$LISTNAME/?before=$GIT_COMMIT                  -> HTML only
+/$LISTNAME/all.html?before=$GIT_COMMIT          -> HTML only, includes replies
+/$LISTNAME/index.atom.xml                       -> Atom feed
+/$LISTNAME/all.atom.xml                         -> Atom feed, includes replies
+/$LISTNAME/mid/$MESSAGE_ID.html                 -> HTML content
+/$LISTNAME/mid/$MESSAGE_ID.txt                  -> raw text
+
+We use file name suffixes on all of these (except /) so URLs may easily
+cached/memoized using a static file server.
-- 
cgit v1.2.3-24-ge0c7