friendica/doc
Michael Vogel 4a69b53d98
Apply suggestions from code review
Co-authored-by: Hypolite Petovan <hypolite@mrpetovan.com>
2021-06-15 19:19:34 +02:00
..
database Handling of special characters 2021-06-14 12:38:42 +00:00
de Apply suggestions from code review 2021-06-15 19:19:34 +02:00
html Move Doxyfile to base directory 2018-11-28 23:09:35 -05:00
img Remove references to removed frost theme 2021-02-09 23:25:47 -05:00
Accesskeys.md Add link to user groups from /contact 2018-11-17 18:33:12 +01:00
Account-Basics.md Update Module\Help to use anchor words for titles 2019-12-09 22:50:37 -05:00
Addons.md Move the 'authenticate' hook deeper into the authentication flow so that password authentication addons are consulted whenever a user's password needs confirming. 2021-05-19 13:11:31 -07:00
AddonStorageBackend.md Remove yesno option from Storage backend 2020-02-05 21:37:32 -05:00
API-Entities.md Add documentation for api/friendica/events endpoint 2020-02-16 12:09:07 -05:00
API-Friendica.md Add documentation for api/friendica/events endpoint 2020-02-16 12:09:07 -05:00
API-GNU-Social.md Rework API documentation 2019-12-09 22:50:38 -05:00
API-Mastodon.md Documentation: The list of supported clients had been reworked 2021-06-14 16:30:31 +00:00
API-Twitter.md Add support for max_id parameter in new Twitter contact API endpoints 2020-06-09 08:36:53 -04:00
api.md Rework API documentation 2019-12-09 22:50:38 -05:00
autoloader.md add missing namespaces/fix wrong class-names 2020-01-19 16:31:35 +01:00
BBCode.md Remove support for [iframe] BBCode 2020-12-18 10:32:36 -05:00
Bugs-and-Issues.md
Chats.md Update references to the friendica/friendica-addons stable branch 2020-06-30 15:25:17 -04:00
Composer.md Move util/composer.ohar to bin/ 2018-03-18 23:15:31 -04:00
Config.md Dynamic config loading 2019-07-16 20:16:43 +02:00
Connectors.md
database.md Handling of special characters 2021-06-14 12:38:42 +00:00
Developer-Domain-Driven-Design.md Create documentation about Domain-Driven-Design 2020-01-06 21:39:05 -05:00
Developer-How-To-Move-Classes-to-src.md Fix PHP cannot take a shell script 2018-03-24 12:47:40 +01:00
Developers-Intro.md Replace profile tab GET parameter by route 2020-01-27 19:21:18 -05:00
events.md
Export-Import-Contacts.md add documentation for contact exports 2019-11-03 14:34:36 +01:00
FAQ.md Apply suggestions from code review 2021-06-15 19:19:34 +02:00
Forums.md Update Forums.md 2020-09-07 19:32:15 -04:00
Github.md Update references to the friendica/friendica stable branch 2020-06-30 15:25:16 -04:00
Groups-and-Privacy.md
Home.md added note about the public chat rooms being logged 2021-05-25 09:36:32 +02:00
Improve-Performance.md [DOCS] Titles: Fix spaces 2018-04-24 13:20:44 +02:00
install-ejabberd.md Move scripts/auth_ejabberd.php to bin/ 2018-03-18 23:17:31 -04:00
Install.md Update Install.md 2021-02-15 23:25:46 +01:00
Installing-Connectors.md Update documentation with new config style/name 2018-11-25 01:56:02 -05:00
KeyboardShortcuts.md
Making-Friends.md [DOCS] Titles: Fix spaces 2018-04-24 13:20:44 +02:00
Message-Flow.md Delete include/items.php 2020-07-14 10:21:31 -04:00
Migrate.md modified: doc/Migrate.md 2020-11-30 12:00:07 +07:00
Move-Account.md Added documentation about the limits of the user import (#5683) 2018-08-27 16:00:59 -04:00
Protocol.md
Quick-Start-andfinally.md
Quick-Start-groupsandpages.md Change iframe address 2019-02-20 20:32:01 +01:00
Quick-Start-guide.md Made some documentation changes/improvements for #6478 2019-03-22 23:13:28 -04:00
Quick-Start-makingnewfriends.md
Quick-Start-network.md
README.md typo and rewrite 2020-10-05 07:19:26 +02:00
Remove-Account.md And another documentation improvment 2019-09-13 20:56:32 +00:00
Settings.md The frontend worker is removed 2021-01-01 23:05:26 +00:00
smarty3-templates.md Add translation to required labels on input fields 2020-12-19 22:52:45 -05:00
SSL.md Update SSL.md 2019-08-19 23:24:36 +02:00
Tags-and-Mentions.md Continued a bit: 2018-06-20 22:19:54 +02:00
Tests.md Add API tests 2018-05-10 19:12:00 +02:00
Text_comment.md Remove references to removed frost theme 2021-02-09 23:25:47 -05:00
Text_editor.md Remove references to removed frost theme 2021-02-09 23:25:47 -05:00
themes.md Update references to the friendica/friendica stable branch 2020-06-30 15:25:16 -04:00
tools.md Apply suggestions from code review 2020-09-16 20:23:27 +02:00
translations.md Update references to the friendica/friendica stable branch 2020-06-30 15:25:16 -04:00
Two-Factor-Authentication.md Add trusted browsers user setting module 2021-01-23 05:42:59 -05:00
Update.md Improve formatting in doc/Update.md 2021-02-07 22:00:47 -05:00
Vagrant.md Update documentation with new config style/name 2018-11-25 01:56:02 -05:00

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 where the texts are maintained. 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 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 docdb`.