diff options
| author | Alexandre Hannud Abdo <abdo@member.fsf.org> | 2014-04-04 19:19:43 -0300 |
|---|---|---|
| committer | Alexandre Hannud Abdo <abdo@member.fsf.org> | 2014-04-04 19:31:48 -0300 |
| commit | 022473bf6fbebcd75c9d35add36e7cf9947dabd5 (patch) | |
| tree | 350665eef5e32a45f1ccd73ba53efb24f8b02998 /doc/to_do_doco.md | |
| parent | 3f1a78fa690e2220b46823527f3abf0a0d51cd8e (diff) | |
| download | volse-hubzilla-022473bf6fbebcd75c9d35add36e7cf9947dabd5.tar.gz volse-hubzilla-022473bf6fbebcd75c9d35add36e7cf9947dabd5.tar.bz2 volse-hubzilla-022473bf6fbebcd75c9d35add36e7cf9947dabd5.zip | |
Update documentation on connecting to channels and on documentation.
Diffstat (limited to 'doc/to_do_doco.md')
| -rw-r--r-- | doc/to_do_doco.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/to_do_doco.md b/doc/to_do_doco.md new file mode 100644 index 000000000..6e4f17724 --- /dev/null +++ b/doc/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)
|