diff --git a/Doc/sphinx/TODO b/Doc/sphinx/TODO index 7c3e6d5..97d1211 100644 --- a/Doc/sphinx/TODO +++ b/Doc/sphinx/TODO @@ -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? diff --git a/Doc/sphinx/docdoc.rst b/Doc/sphinx/docdoc.rst index 23e4e8b..4ab4b55 100644 --- a/Doc/sphinx/docdoc.rst +++ b/Doc/sphinx/docdoc.rst @@ -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 ) + diff --git a/Doc/sphinx/index.rst b/Doc/sphinx/index.rst index 31630fc..0122669 100644 --- a/Doc/sphinx/index.rst +++ b/Doc/sphinx/index.rst @@ -24,6 +24,7 @@ Contents: reference.rst scriptreference.rst docdoc.rst + todo.rst pymml.rst diff --git a/Doc/sphinx/todo.rst b/Doc/sphinx/todo.rst new file mode 100644 index 0000000..bd606a2 --- /dev/null +++ b/Doc/sphinx/todo.rst @@ -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? + +