From 9c076dd3fa391329454a8357f2d535dff8320579 Mon Sep 17 00:00:00 2001
From: Evan Prodromou <evan@prodromou.name>
Date: Wed, 11 Jun 2008 13:06:24 -0400
Subject: [PATCH] more documentation

darcs-hash:20080611170624-84dde-25c41cf9b285b65fecd67e8496c85c225df95ef9.gz
---
 doc/faq               |  6 +++++
 doc/help              | 15 +++++++++++
 doc/{TODO => roadmap} | 63 ++++++++++++++++++++++++++++++++++++-------
 3 files changed, 74 insertions(+), 10 deletions(-)
 create mode 100644 doc/faq
 create mode 100644 doc/help
 rename doc/{TODO => roadmap} (84%)

diff --git a/doc/faq b/doc/faq
new file mode 100644
index 0000000000..905c1ab77c
--- /dev/null
+++ b/doc/faq
@@ -0,0 +1,6 @@
+FAQ
+---
+
+These are some *Frequently Asked Questions* about this service, with
+some answers.
+
diff --git a/doc/help b/doc/help
new file mode 100644
index 0000000000..90efa63b2f
--- /dev/null
+++ b/doc/help
@@ -0,0 +1,15 @@
+Help
+----
+
+This Web site is a *microblogging* service -- a way for you to tell
+your friends and fans about what you're doing, wherever you are. You
+can post small (140 characters or less) texts to the site, and all
+your friends who "subscribe" to your posts will receive messages from
+you.
+
+The code is available under a Free Software/Open Source license, which
+means that you can set up your /own/ microblogging service. It
+supports the [OpenMicroBlogging](http://openmicroblogging.org/)
+standard, so that people using different services can subscribe to
+each others notices with as little work as necessary.
+
diff --git a/doc/TODO b/doc/roadmap
similarity index 84%
rename from doc/TODO
rename to doc/roadmap
index b133b3bfa7..c89f265b91 100644
--- a/doc/TODO
+++ b/doc/roadmap
@@ -1,3 +1,17 @@
+Roadmap
+-------
+
+This is a roadmap of tasks for different versions of the
+[Laconica](http://laconi.ca/) software. It's meant to help answer the
+question, "Is Laconica ever going to have such-and-such a feature?" or
+"When will Laconica do such-and-such?"
+
+Release 0.1
+-----------
+
+This was an internal milestone release, mostly for developing the core
+functionality.
+
 + login
 + register
 + settings
@@ -24,7 +38,14 @@
 + date in shown notice links to notice page
 + common_redirect()
 + configuration system ($config)
-+ release 0.1
+
+Release 0.2
+-----------
+
+Another internal milestone. Bumped up from cruddy caveman HTML to a
+borrowed design from [OSWD](http://www.oswd.org/), added a lot of RSS
+generation, and more careful form validation.
+
 + design from Open Source Web Designs
 + add H1 to each page
 + add H2 for each page section
@@ -52,7 +73,13 @@
 + source link in footer menu
 + public stream link in top menu
 + dump, fix, undump database
-+ release 0.2
+
+Release 0.3
+-----------
+
+First public release (theoretically). Added distributed subscriptions,
+"fancy" URLs, and a new graphic design for stoi.ca.
+
 + YADIS document link on showstream
 + YADIS document
 + subscribe remote
@@ -70,11 +97,11 @@
 + pretty URLs
 + doc action
 + about doc
-- help doc
++ help doc
 - FAQ doc
 + privacy doc
 + source doc
-- roadmap doc
++ roadmap doc
 - contact doc
 - add a way to stick variables into documents
 + FOAF document for user
@@ -120,7 +147,10 @@
 + correct use of views menu in settings
 + correct use of views menu in streams
 - INSTALL file
-- release 0.3
+
+Release 0.4
+-----------
+
 - microid for profile page
 - format times per user
 - timezone preferences in Profile settings
@@ -142,7 +172,10 @@
 - site logo
 - check license compatibility for remote subscribe
 - optional FOAF URL in openmicroblogging exchange
-- release 0.4
+
+Release 0.5
+-----------
+
 - content negotiation for charset (iconv?)
 - license per notice
 - use only canonical email addresses
@@ -165,7 +198,10 @@
 - license per attachment
 - forward notices to Jabber
 - receive notices from Jabber
-- release 0.5
+
+Release 0.6
+-----------
+
 - URL notices
 - image notices
 - video notices
@@ -175,7 +211,10 @@
 - receive notices from other IM
 - receive notices from mobile phone
 - machine tags
-- release 0.6
+
+Release 1.0
+-----------
+
 - OAuth for third-party tools (desktop, other sites)
 - Twitter-compatible API
 - Pownce-compatible API
@@ -185,6 +224,10 @@
 - Wrap DB_DataObject with memcached caching layer
 - login throttle to prevent brute-force attacks
 - form token in login to prevent XSS
-- release 1.0
+
+Post-1.0
+--------
+
 - Atom Publishing Protocol
-- "Universal" public feed
\ No newline at end of file
+- "Universal" public feed
+- global registry (LDAP at openmicroblogging.net, maybe?)
\ No newline at end of file