From 6ecdcbed20920c2816657ccbd4f5063f92841683 Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Sun, 4 Oct 2020 20:27:27 +0200 Subject: [PATCH 1/3] typos --- doc/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 000000000..12aa89f0c --- /dev/null +++ b/doc/README.md @@ -0,0 +1,19 @@ +# About the docs of the Friendica Project + +## User and Admin documentation + +Every Friendica node has the _current_ version of the user and admin documentation avail-able in the `/help` location. +The documentation is mainly done in English, but the pages are translate able and some are already translated 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`. From d0d4245dc020a3c8076dad6cc435017caeb231ad Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Sun, 4 Oct 2020 20:34:39 +0200 Subject: [PATCH 2/3] added some hint about broken links at github --- doc/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/README.md b/doc/README.md index 12aa89f0c..797ac09ca 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,5 +1,7 @@ # 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 avail-able in the `/help` location. From c6fda0c4ed371aad4d145a42d9abb9fb6069a9ef Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Mon, 5 Oct 2020 07:19:26 +0200 Subject: [PATCH 3/3] typo and rewrite --- doc/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 797ac09ca..4902b4cdf 100644 --- a/doc/README.md +++ b/doc/README.md @@ -4,8 +4,8 @@ ## User and Admin documentation -Every Friendica node has the _current_ version of the user and admin documentation avail-able in the `/help` location. -The documentation is mainly done in English, but the pages are translate able and some are already translated to German. +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.