strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #9360 from tobiasd/docReadme

Browse source 
a README for the docs directory
This commit is contained in:
Hypolite Petovan 2020-10-05 05:28:41 -04:00 committed by GitHub
parent f096b8c879 c6fda0c4ed
commit cc42c0ba27
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/README.md Normal file
View file

@ -0,0 +1,21 @@
# About the docs of the Friendica Project
**Note**: It is expected that some of the links in these files wont work in the Friendica repository as they are supposed to work on an installed Friendica node.
## User and Admin documentation
Every Friendica node has the _current_ version of the user and admin documentation available in the `/help` location.
The documentation is mainly done in English, but the pages can be translated and some are already to German.
If you want to help expanding the documentation or the translation, please register an account at the [Friendica wiki](https://wiki.friendi.ca) where the [texts are maintained](https://wiki.friendi.ca/docs).
The documentation is periodically merged back from there to the _development_ branch of Friendica.
Images that you use in the documentation should be located in the `img` sub-directory of this directory.
Translations are located in sub-directories named after the language codes, e.g. `de`.
Depending on the selected interface language the different translations will be applied, or the `en` original will be used as a fall-back.
## Developers Documentation
We provide a configuration file for [Doxygen](https://www.doxygen.nl/index.html) in the root of the Friendica repository.
With that you should be able to extract some documentation from the source code.
In addition there are some documentation files about the database structure in `doc`db`.