mirror of
https://github.com/YunoHost-Apps/hubzilla_ynh.git
synced 2024-09-03 19:26:21 +02:00
31 lines
893 B
Markdown
31 lines
893 B
Markdown
# 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)
|
|
|
|
#include doc/macros/main_footer.bb;
|