This commit is contained in:
Merlijn Wajer 2010-06-14 00:27:10 +02:00
parent b99daffe6b
commit 913992f18f
4 changed files with 35 additions and 5 deletions

View File

@ -1,6 +1,9 @@
# Change a minus to a plus when something is being worked on.
# Remove it when you are done.
# GENERAL
- Run spellcheck before you commit (make sure you ignore section names
@ -14,8 +17,3 @@
# ADDING CONTENT
- Expand "Troubleshooting"
- And its subsection.
- Expand "Feature Overview"
- And its subs. There's like nothing in them, those are the type
of pages I was talking about. Combine them under feature overview?

View File

@ -68,3 +68,4 @@ Simba specific words (like Simba itself) capitalized.
Try to stick to the Python documentation standards.
( http://docs.python.org/using/index.html )

View File

@ -24,6 +24,7 @@ Contents:
reference.rst
scriptreference.rst
docdoc.rst
todo.rst
pymml.rst

30
Doc/sphinx/todo.rst Normal file
View File

@ -0,0 +1,30 @@
Documentation TODO
==================
* bugreport. Put general ``rules`` for commiting bugs in there.
What to report, what not to report,
check if a bug already exists, what info should be
added, etc.
* whatsnew. it's still very short, we could probably add some of the latest
features. perhaps some info about the script manager.
* script manager (non technical) I (wizzup) will do this myself
* script manager (technical) I (wizzup) will do this myself
* extend getting started. this probably requires some script manager stuff
* think of good chapters for the complete tutorial.
* write a lot more chapters for simba references. There's plenty to document.
* Expand "Troubleshooting"
- And its subsection.
* Expand "Feature Overview"
- And its subs. There's like nothing in them, those are the type
of pages I was talking about. Combine them under feature overview?