]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: add design documentation for WWW interface
authorEric Wong <normalperson@yhbt.net>
Fri, 4 Apr 2014 23:28:53 +0000 (23:28 +0000)
committerEric Wong <normalperson@yhbt.net>
Sat, 5 Apr 2014 06:55:35 +0000 (06:55 +0000)
Mainly, start with URL routes since that's what users usually
see, first.

Documentation/design_www.txt [new file with mode: 0644]

diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
new file mode 100644 (file)
index 0000000..f6ed26a
--- /dev/null
@@ -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.