[pypy-svn] r4774 - pypy/trunk/doc

[anna at codespeak.net]

Author: anna
Date: Mon May 31 18:33:10 2004
New Revision: 4774

Modified:
   pypy/trunk/doc/index.txt
Log:
index for documentation page with hyperlinks

Modified: pypy/trunk/doc/index.txt
==============================================================================
--- pypy/trunk/doc/index.txt	(original)
+++ pypy/trunk/doc/index.txt	Mon May 31 18:33:10 2004
@@ -1,41 +1,60 @@
-Pypy Documentation Tree
-=======================
+Pypy Documentation 
+==================
 
 We have a fair amount of documentation for the Pypy project. The files are available from the website as html (view them along the left side of the pypy doc web-page). They are also available from the repository, under the doc/ directory or under the src/devel directory. 
 
-If you just want an overview of the project, take a look at our presentation to OSCON:
- 
- * doc/oscon2003-paper::
+Overview
+--------
+
+If you just want an overview of the project, take a look at these items in doc/.
+
+ * architecture_:
+	a more technical overview of the current architecture 
+
+ * oscon2003-paper_:
 	presentation to OSCON on what pypy is about and why you should care
 
-If you are wanting to get involved, take a look at the following documentation to get a better taste:
+Getting Started
+---------------
+
+If you are wanting to get involved, take a look at the following documentation (also found in doc/) to get a better taste:
 
- * doc/howtopypy::
+ * howtopypy_:
 	provides some hands-on instructions for getting started
+	
 
- * doc/readme::
+ * readme_:
 	this file is on using ReST for pypy documentation
 
- * doc/architecture::
-	an overview of the current architecture 
 
- * doc/wrapping::
-	a description of application-level and interpreter-level wrapped 	objects
+ * wrapping_:
+	a description of application-level and interpreter-level wrapped 		objects
 
-Before doing pypy work, you should also take a look at these developer-specific instructions:
+Before you code
+---------------
 
- * devel/coding-style::
-	covers pypy coding conventions
+Before doing pypy work, you should also take a look at these developer-specific instructions, found in the src/devel/ directory of the repository:
 
- * devel/howtosvn::
-	for new users of subversion
+ * coding-style_:
+	covers pypy coding conventions
 
- * checking_ReST::
-	if you are adding documentation, look at both the doc/readme 		mentioned above and this file: 		
+ * howtosvn_:
+	for new users of subversion	
 
- * optionaltool::
+ * optionaltool_:
 	there are some optional tools we use for pypy. 
 
- * testdesign::
+ * testdesign_:
 	pypy is a test-driven development project.read here to find out more 	about how we're doing testing.
-	
\ No newline at end of file
+	
+
+
+.. _architecture: http://codespeak.net/pypy/index.cgi?doc/architecture.html
+.. _oscon2003-paper: http://codespeak.net/pypy/index.cgi?doc/oscon2003-paper.html
+.. _howtopypy: http://codespeak.net/pypy/index.cgi?doc/howtopypy.html
+.. _readme: http://codespeak.net/pypy/index.cgi?doc/readme.html
+.. _wrapping: http://codespeak.net/pypy/index.cgi?doc/wrapping.html
+.. _coding-style: http://codespeak.net/pypy/index.cgi?doc/devel/coding-style.html
+.. _howtosvn: http://codespeak.net/pypy/index.cgi?doc/devel/howtosvn.html
+.. _optionaltool: http://codespeak.net/pypy/index.cgi?doc/devel/optionaltool.html
+.. _testdesign: http://codespeak.net/pypy/index.cgi?doc/devel/testdesign.html
\ No newline at end of file