2008-10-27 Rodrigo Kumpera <rkumpera@novell.com>

[mono.git] / web / classlib-doc

diff --git a/web/classlib-doc b/web/classlib-doc
index b002b8efd552a37852b5a8317a21955f9d90493b..d86969ed119a07fdfea700ee2ed059cf1a477d36 100644 (file)
--- a/web/classlib-doc
+++ b/web/classlib-doc
@@ -7,34 +7,43 @@
        the code, making the source quite difficult to read.  Furthermore,
        multilingual documentation makes for significant additional text.
        
-       With these considerations in mind, Mono will use external XML files
-       for type documentation, rather than documenting the source
+       With these considerations in mind, Mono is using external XML files
+       for class documentation, rather than documenting the source
        inline.  The XML file format used is inspired by the XML format used
        to document the ECMA APIs.  
 
-       Several tools will be created for managing, verifying, generating,
-       and updating class library documentation, including:
+       Several tools exist for managing, verifying, generating,
+       and updating class library documentation.
+
+       The documentation infrastructure is part of the `Monodoc'
+       module.  Monodoc includes a graphical GUI browser and tools to
+       generate the initial stubbed XML document out of an assembly.
        
-       <ul>
-               <li><a href="#monodoc">monodoc - A graphical documentation viewer.</a></li>
-               <li>xmllint: a tool used to validate a proper XML document.
-       </ul>
+       Download `monodoc' to start producing documentation for your
+       application. 
 
-       You can download the tools to document Mono from the CVS
-       repository from module `monodoc'.
+       For instructions, read the monodoc/README file.
 
 ** Documentation Tools
 
 *** <a name="monodoc">MonoDoc</a>
 
-        A graphical documentation viewer written in Gtk#.  In the
-       future we will have an ASP.NET front-end to present the
-       documentation on the web as well.
+       The MonoDoc system offers both a GUI client as well as a <a
+       href="http://www.go-mono.com:8080">Web-based interface</a> to
+       the documentation.
+
+       The GUI edition uses <a
+       href="http://gtk-sharp.sf.net">Gtk#</a> and the Web edition
+       uses Mono's ASP.NET implementation. 
 
-** Status and Roadmap
+       <img src="images/Screenshot-Monodoc.png">
 
 ** Get Involved
 
        Help us develop Mono's documentation tools!  Subscribe to
        <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
        and wade right in.
+
+       Monodoc today also supports a GUI-based collaborative editing
+       system.  You can now edit the documentation from the MonoDoc
+       Browser and upload your contributions directly to the Mono site.