about summary refs log tree commit homepage
path: root/Documentation/design_www.txt
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2014-04-04 23:28:53 +0000
committerEric Wong <normalperson@yhbt.net>2014-04-05 06:55:35 +0000
commit8d20886bd0638561ddd677a4e19a4f01022bdfde (patch)
treecfdf9a2995569915adbc981455fa7d0b69ad3b49 /Documentation/design_www.txt
parent1397205077a2b2d196f6c469a15a4a4721f1d15f (diff)
downloadpublic-inbox-8d20886bd0638561ddd677a4e19a4f01022bdfde.tar.gz
Mainly, start with URL routes since that's what users usually
see, first.
Diffstat (limited to 'Documentation/design_www.txt')
-rw-r--r--Documentation/design_www.txt12
1 files changed, 12 insertions, 0 deletions
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.