From 36feec47dcc10213c1a66596259fa91d49a26a85 Mon Sep 17 00:00:00 2001
From: Chris Eppstein <chris@eppsteins.net>
Date: Sun, 24 Jan 2010 16:11:00 -0800
Subject: [PATCH] document the documentation.

---
 doc-src/README.markdown | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 doc-src/README.markdown

diff --git a/doc-src/README.markdown b/doc-src/README.markdown
new file mode 100644
index 00000000..5992ae27
--- /dev/null
+++ b/doc-src/README.markdown
@@ -0,0 +1,30 @@
+Documentation README
+====================
+
+This is the documentation for Compass. Much of the documentation is read from the
+sass source files to keep the docs in-line with current state of the code as much as
+possible.
+
+If you're reading this, you might be thinking about helping to improve the compass documentation by editing existing documentation or by adding new documentation.
+
+There are two main kinds of documentation:
+
+* Tutorials: Describe HOW to use compass.
+* Reference: Details about WHAT compass has.
+
+It's possible and encouraged for related tutorials and reference documentation to
+link to each other.
+
+## Getting Around the Documentation Project
+
+* `.compass/config.rb` - This is where the compass configuration is kept.
+* `content/` - This directory is where content for the documentation project is kept.
+* `content/reference` - This is where reference documentation is kept.
+* `content/tutorials` - This is where tutorial documentation is kept.
+* `content/css` - Third-party, plain old CSS files.
+* `content/images` - Images. Duh.
+* `content/javascripts` - Javascripts. Double Duh.
+* `content/stylesheets` - Sass stylesheets for the project.
+* `layouts` - Layouts are kept here.
+* `layouts/partials` - Partials are kept here.
+* `lib` - Ruby code. Helper code and sass source inspection is done here.