Permalink
Browse files

Can't stop messing with the documentation.

I want to include a reasonable introduction to what I mean by topic
trees, but I also don't want people to fall asleep thinking they have to
read it. So I'm trying to find a balance between making the information
easily available (early in the docs) and setting expectations
appropriately. Maybe this current version will make me happier.
  • Loading branch information...
1 parent e377050 commit d31aa90a5a56d56bf410e28fadd6403758b52934 Malcolm Tredinnick committed Jul 12, 2009
Showing with 11 additions and 10 deletions.
  1. +3 −3 docs/index.rst
  2. +8 −7 docs/{introduction.rst → what.rst}
View
@@ -2,8 +2,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Documentation For Acacia
-========================
+Acacia: Simple Topic Trees For Django
+=====================================
Acacia is a small Django application that provides hierarchical topic or
category objects. Other Django applications can then use the topic trees to
@@ -16,7 +16,7 @@ Contents:
.. toctree::
:maxdepth: 2
- introduction
+ what
basic-usage
advanced-usage
implementation
@@ -1,6 +1,6 @@
-============
-Introduction
-============
+======================
+What Are Topic Trees?
+======================
Topic Trees Versus Tagging
===========================
@@ -39,8 +39,8 @@ last decade has shown that. However, if you need a more structured system, it
is worth using a proper tree-like modelling scheme, rather than trying to fake
the names with tags.
-Topic Trees Are Trees Plus Some Extras
-=======================================
+Trees With Some Extra Features
+===============================
If you are in a situation where an hierarchical labelling system is
appropriate, it might seem that you are somewhat be spoilt for choice. There
@@ -59,8 +59,9 @@ topics or categories using a human-readable name. Internally, the nodes in the
tree are not stored or related in that fashion, so some conversion functions
are always necessary.
-What Acacia Provides
----------------------
+
+Acacia's Approach
+------------------
Acacia has been developed to provide an extra layer of wrapper functions in
order to make those common lookup patterns (and similar manipulations) easy. It

0 comments on commit d31aa90

Please sign in to comment.