friendica-github/doc
Hank G b243df5125
Update doc/API-Entities.md
Co-authored-by: Hypolite Petovan <hypolite@mrpetovan.com>
2023-02-23 10:32:09 -05:00
..
database Remove addon table from DB structure 2023-02-21 09:07:19 -05:00
de Remove App dependency from Hook::callSingle 2023-01-14 10:38:37 -05:00
html Move Doxyfile to base directory 2018-11-28 23:09:35 -05:00
img Deprecate themes duepuntozero, quattro and smoothly 2022-11-05 00:06:10 -04:00
Accesskeys.md New area "moderation" 2022-11-08 02:28:42 -05:00
Account-Basics.md Update Module\Help to use anchor words for titles 2019-12-09 22:50:37 -05:00
Addons.md Remove App dependency from Hook::callSingle 2023-01-14 10:38:37 -05:00
AddonStorageBackend.md Restructure Storage to new paradigm 2021-10-27 20:00:19 +02:00
API-Entities.md Update doc/API-Entities.md 2023-02-23 10:32:09 -05:00
API-Friendica.md Add new Friendica Photo Album GET endpoints to documentation 2023-02-22 22:35:24 -05:00
API-GNU-Social.md API: Support for deprecated API endpoints and OAuth removal 2021-07-20 20:48:37 +00:00
API-Mastodon.md Add Mastodon Instance::V2 Friendica extension documentation 2023-02-23 06:46:43 -05: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 API: Support for deprecated API endpoints and OAuth removal 2021-07-20 20:48:37 +00:00
autoloader.md All references to boot.php are now removed 2022-10-19 20:38:25 +00:00
BBCode.md Remove obsolete <div class="clear"></div> from body-attach div 2022-12-14 22:35:12 -05:00
Bugs-and-Issues.md move to forum.friendi.ca 2017-10-08 11:25:35 +02:00
Chats.md Update references to the friendica/friendica-addons stable branch 2020-06-30 15:25:17 -04:00
Composer.md All references to boot.php are now removed 2022-10-19 20:38:25 +00:00
Config.md Update doc/Config.md from review suggestion 2022-11-20 18:14:37 -05:00
Connectors.md Move settings/addons to src/Module 2022-11-09 06:25:41 -05:00
database.md Fix database 2023-02-21 21:01:57 +01:00
Developer-Domain-Driven-Design.md old boot.php functions replaced in various places 2022-10-19 07:44:08 -04: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 All references to boot.php are now removed 2022-10-19 20:38:25 +00:00
events.md Remove event.adjust field 2021-10-03 13:42:32 -04:00
Export-Import-Contacts.md Contact ex- and import should work with Misskey CSV files as well 2022-02-11 13:47:06 +01:00
FAQ-admin.md doc/themes.md,FAQ-admin: point to live friendica-themes.com mirror 2022-04-07 02:36:05 +02:00
FAQ.md update FAQ client list: remove Fedi from iOS apps 2022-12-19 20:04:21 +01: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 missing line breaks and some updates 2017-09-21 09:36:52 +02:00
Home.md Apply suggestions from code review 2021-11-15 17:30:50 +01: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 [docs] note the preference of MariaDB over other MySQL implementation in the install docs 2022-10-16 10:14:18 +02:00
Installing-Connectors.md Update documentation with new config style/name 2018-11-25 01:56:02 -05:00
KeyboardShortcuts.md Doc about j/k keyboard shortcuts 2017-04-13 17:20:05 +02:00
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 Create new User\Import module class 2022-11-02 11:27:31 -04:00
Protocol.md docu docs: some polishing 2016-12-06 15:03:57 +01:00
Quick-Start-andfinally.md move to forum.friendi.ca 2017-10-08 11:25:35 +02:00
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 added missing line breaks 2017-09-21 09:53:46 +02:00
Quick-Start-network.md added missing line breaks 2017-09-21 09:53:46 +02:00
README.md typo and rewrite 2020-10-05 07:19:26 +02:00
Remove-Account.md Create new Settings\RemoveMe module class 2022-11-08 18:33:54 -05: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 Deprecate themes duepuntozero, quattro and smoothly 2022-11-05 00:06:10 -04:00
Text_editor.md Deprecate themes duepuntozero, quattro and smoothly 2022-11-05 00:06:10 -04:00
themes.md Deprecate themes duepuntozero, quattro and smoothly 2022-11-05 00:06:10 -04:00
tools.md fixed the typo 2022-12-29 14:45:51 +01:00
translations.md Fix messages.po and adapt README 2022-12-29 21:30:01 +01: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 adopt IP change in the Vagrant docs 2022-10-15 17:33:47 +02: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`.