diff options
| author | root <root@v22013111044215586.yourvserver.net> | 2014-06-29 18:32:40 +0200 |
|---|---|---|
| committer | root <root@v22013111044215586.yourvserver.net> | 2014-06-29 18:32:40 +0200 |
| commit | a47971aefd2bee45f4e57dd1fc3ea24bb370881f (patch) | |
| tree | 957bd627cf9016cc826b5a5bbfb6001f4edc4830 /doc/old/to_do_doco.md | |
| parent | 5df50c4a0bf80f3697c7088c9c4a3815206fe97d (diff) | |
| download | volse-hubzilla-a47971aefd2bee45f4e57dd1fc3ea24bb370881f.tar.gz volse-hubzilla-a47971aefd2bee45f4e57dd1fc3ea24bb370881f.tar.bz2 volse-hubzilla-a47971aefd2bee45f4e57dd1fc3ea24bb370881f.zip | |
Some doco work. Changed main.bb and added a return link to all .bb files and began planning new entries for user orientated documentation.
Diffstat (limited to 'doc/old/to_do_doco.md')
| -rw-r--r-- | doc/old/to_do_doco.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/old/to_do_doco.md b/doc/old/to_do_doco.md new file mode 100644 index 000000000..6e4f17724 --- /dev/null +++ b/doc/old/to_do_doco.md @@ -0,0 +1,29 @@ +# Documentation To-Do List #
+
+## How to contribute documentation ##
+
+Documentation files are in */doc*.
+
+When help is first accessed, the file loaded is *main.bb*. That file contains case sensitive links without an extension. The extensions is added automatically if the file is found, first *.md* then *.bb*.
+
+For translating documentation, create a directory in */doc* named by the language code, copy the files and translate the content.
+
+## Documentation we need to write ##
+
+* Database schema detailed descriptions
+
+* Complete plugin hook documentation
+
+* API documentation
+
+* Function and code documentation (doxygen)
+
+* New Member guide
+
+* "Extra Feature" reference, description of each
+
+* Detailed Personal Settings Documentation
+
+* Administration Guide (post-install)
+
+* Administration Guide (pre-install)
|