huge refactor of encoding handling

[public-inbox.git] / Documentation / design_www.txt

diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index 0d25a45a5dae5039c99bf84e483fc07e5616b214..a265a890bd21ec36c364f73087610428686ba4d7 100644 (file)
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -3,8 +3,7 @@ URL naming
 
 ### Unstable endpoints
 /$LISTNAME/?r=$GIT_COMMIT                       -> HTML only
-/$LISTNAME/index.atom.xml                       -> Atom feed
-/$LISTNAME/all.atom.xml                         -> Atom feed, includes replies
+/$LISTNAME/atom.xml                             -> Atom feed
 
 ### Stable endpoints
 /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
@@ -14,6 +13,9 @@ URL naming
 /$LISTNAME/f/$MESSAGE_ID                        -> 301 to .html version
 /$LISTNAME/f/$MESSAGE_ID.txt                    -> 301 to m/$MESSAGE_ID.txt
 
+FIXME: we must refactor/cleanup/add tests for most of our CGI before
+adding more endpoints and features.
+
 Maybe TODO (these might be expensive)
 -------------------------------------
 /$LISTNAME/t/$MESSAGE_ID.html                   -> HTML content of thread
@@ -22,6 +24,15 @@ Maybe TODO (these might be expensive)
 We use file name suffixes on all of these (except /) so URLs may easily
 cached/memoized using a static file server.
 
+Encoding notes
+--------------
+
+Raw HTML and XML should only contain us-ascii characters which render
+to UTF-8.
+
+Plain text (raw message) endpoints display in the original encoding(s)
+of the original email.
+
 Guidelines for using limited HTML
 ---------------------------------
 We mainly use HTML for linking pages together with <a>.