Added a bit of a landing page to the api docs

jagregory · jagregory · commit eaef6c13861d · 2010-05-19T22:31:31.000-06:00
diff --git a/tools/docu/templates/index.htm.spark b/tools/docu/templates/index.htm.spark
@@ -1,17 +1,35 @@
 ﻿<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-	<head>
-		<title>${WriteProductName(Assemblies[0])} Documentation</title>
-		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-		<link type="text/css" rel="stylesheet" href="main.css" />
-	</head>
-	<body>
+  <head>
+    <title>${WriteProductName(Assemblies[0])} Documentation</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+    <link type="text/css" rel="stylesheet" href="main.css" />
+  </head>
+  <body id="index">
     <namespaces />
     <types />
     <div class="header">
-		<p class="class">${WriteProductName(Assemblies[0])} Documentation</p>
-	</div>
-    
+      <p class="class">${WriteProductName(Assemblies[0])} Documentation</p>
+    </div>
+
+    <div id="index">
+      <p><strong>You're reading the Fluent NHibernate API documentation.</strong> Above are all the namespaces
+        and types in Fluent NHibernate. Not everything will be of interest to you, as most of it is internal
+        workings, but you can find the public classes in here too. Not all our classes are documented, but we're
+        working on it; these docs are updated on every commit of Fluent NHibernate, so if something isn't documented
+        let us know and we'll update it.</p>
+
+      <p>Classes of interest:</p>
+      <ul>
+        <li><a href="FluentNHibernate.Mapping/ClassMap`1.htm">ClassMap&lt;T&gt;</a> - used to map your entities</li>
+        <li><a href="FluentNHibernate.Mapping/SubclassMap`1.htm">SubclassMap&lt;T&gt;</a> - for mapping any
+          subclasses of entities</li>
+        <li><a href="FluentNHibernate.Mapping/ComponentMap`1.htm">ComponentMap&lt;T&gt;</a> - create reusable component
+          mappings</li>
+        <li><a href="FluentNHibernate.Automapping/AutoMap.htm">AutoMap</a> - the starting point for automapping</li>
+        <li><a href="FluentNHibernate.Cfg/FluentConfiguration.htm">FluentConfiguration</a> - application configuration</li>
+      </ul>
+    </div>
     <use file="_footer" />
   </body>
-</html>
+</html>
diff --git a/tools/docu/templates/main.css b/tools/docu/templates/main.css
@@ -205,4 +205,8 @@ blockquote {
 	border-top-width: 1px;
 	border-bottom-width: 1px;
 	font-size: 90%;
-}
+}
+
+#index p {
+  padding: 10px;
+}
