friendica/doc/Home.md

Friendica Documentation and Resources
=====================================

**User Manual**

* General functions - first steps
	* [Account Basics](help/Account-Basics)
	* [New User Quick Start](help/Quick-Start-guide)
	* [Creating posts](help/Text_editor)
	* [BBCode tag reference](help/BBCode)
	* [Comment, sort and delete posts](help/Text_comment)
	* [Accesskey reference](help/Accesskeys)
	* [Events](help/events)
* You and other users
	* [Connectors](help/Connectors)
	* [Making Friends](help/Making-Friends)
	* [Circles and Privacy](help/Circles-and-Privacy)
	* [Tags and Mentions](help/Tags-and-Mentions)
	* [Community Groups](help/Groups)
	* [Channels](help/Channels)
	* [Chats](help/Chats)
* Further information
	* [Move your account](help/Move-Account)
	* [Export / Import of followed Contacts](help/Export-Import-Contacts)
	* [Delete your account](help/Remove-Account)
	* [Frequently asked questions (FAQ)](help/FAQ)

**Admin Manual**

* [Install](help/Install)
* [Update](help/Update)
* [Settings & Admin Panel](help/Settings)
* [Installing Connectors (Twitter/GNU Social)](help/Installing-Connectors)
* [Install an ejabberd server (XMPP chat) with synchronized credentials](help/install-ejabberd)
* [Using SSL with Friendica](help/SSL)
* [Config values that can only be set in config/local.config.php](help/Config)
* [Improve Performance](help/Improve-Performance)
* [Migrate](help/Migrate)
* [Administration Tools](help/tools)
* [Admin FAQ](help/FAQ-admin)

**Developer Manual**

* [Get started](help/Developers-Intro)
* Set up development environment
	* [Help on GitHub](help/GitHub)
	* [Help on Vagrant](help/Vagrant)
	* [Bugs and Issues](help/Bugs-and-Issues)
* Code structure
    * [Domain-Driven-Design](help/Developer-Domain-Driven-Design)
	* [Addon Development](help/Addons)
	* [Theme Development](help/themes)
	* [Smarty 3 Templates](help/smarty3-templates)
	* [Storage backend addon](help/AddonStorageBackend)
* How To
	* [Translate Friendica](help/translations)
	* [Use Composer](help/Composer)
	* [Move classes to `src`](help/Developer-How-To-Move-Classes-to-src)
	* [Run tests](help/Tests)
* Reference
	* [API endpoints](help/api)
	* [Code (Doxygen generated - sets cookies)](doc/html/)
	* [Protocol Documentation](help/Protocol)
	* [Database schema documentation](help/database)
	* [Class Autoloading](help/autoloader)

**External Resources**

* [Main Website](https://friendi.ca)
* Ways to get Support
  * Friendica Support Group: [@helpers@forum.friendi.ca](https://forum.friendi.ca/~helpers)
  * [Mailing List Archive](http://mailman.friendi.ca/mailman/listinfo/support-friendi.ca) you can subscribe to the list by sending an email to ``support-request(at)friendi.ca?subject=subscribe``
  * Community chat rooms (the IRC, Matrix and XMPP rooms are bridged) these public chats are logged [from IRC](https://gnusociarg.nsupdate.info/2021/%23friendica/) and [Matrix](https://view.matrix.org/alias/%23friendi.ca:matrix.org/)
    * XMPP/Jabber MUC: support(at)forum.friendi.ca
    * IRC: #friendica at [libera.chat](https://web.libera.chat/?channels=#friendica)
    * Matrix: [#friendi.ca](https://matrix.to/#/#friendi.ca:matrix.org) or [#friendica-en](https://matrix.to/#/#friendica-en:matrix.org) at matrix.org

**About**

* [Site/Version Info](friendica)
* [Friendica Credits](credits)
some doc updates 2011-11-08 22:12:01 +00:00			`Friendica Documentation and Resources`
local documentation library 2011-04-13 14:07:21 +00:00			`=====================================`

updated help's table of content 2014-12-28 15:38:19 +00:00			`User Manual`
local documentation library 2011-04-13 14:07:21 +00:00
spelling 2013-05-03 05:21:06 +00:00			`* General functions - first steps`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Account Basics](help/Account-Basics)`
			`* [New User Quick Start](help/Quick-Start-guide)`
			`* [Creating posts](help/Text_editor)`
docs: add documentation about used protocols 2016-11-28 16:55:56 +00:00			`* [BBCode tag reference](help/BBCode)`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Comment, sort and delete posts](help/Text_comment)`
typo in markdown syntax 2015-10-13 16:22:45 +00:00			`* [Accesskey reference](help/Accesskeys)`
docs: add documentation about used protocols 2016-11-28 16:55:56 +00:00			`* [Events](help/events)`
Fixed a small typo 2014-12-28 13:50:43 +00:00			`* You and other users`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Connectors](help/Connectors)`
			`* [Making Friends](help/Making-Friends)`
Replace "Group" with "Circle" in hosted documentation - Replace "Gruppe" with "Circle" in German version 2023-05-13 23:43:07 +00:00			`* [Circles and Privacy](help/Circles-and-Privacy)`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Tags and Mentions](help/Tags-and-Mentions)`
Replace "forum" by "group" in documentation - Replace "Forum" by "Gruppe" in German documentation 2023-05-29 22:31:08 +00:00			`* [Community Groups](help/Groups)`
Channel documentation added 2023-09-23 14:46:15 +00:00			`* [Channels](help/Channels)`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Chats](help/Chats)`
			`* Further information`
updated help's table of content 2014-12-28 15:38:19 +00:00			`* [Move your account](help/Move-Account)`
add documentation for contact exports 2019-11-03 13:34:36 +00:00			`* [Export / Import of followed Contacts](help/Export-Import-Contacts)`
updated help's table of content 2014-12-28 15:38:19 +00:00			`* [Delete your account](help/Remove-Account)`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Frequently asked questions (FAQ)](help/FAQ)`
local documentation library 2011-04-13 14:07:21 +00:00
updated help's table of content 2014-12-28 15:38:19 +00:00			`Admin Manual`
local documentation library 2011-04-13 14:07:21 +00:00
			`* [Install](help/Install)`
Add Update documentation page 2018-01-17 20:30:34 +00:00			`* [Update](help/Update)`
DOCS: clarify Settings also discusses the Admin Panel 2016-08-13 10:11:27 +00:00			`* [Settings & Admin Panel](help/Settings)`
Removed Facebook from the documentation. Renamed Statusnet to GNU Social 2015-08-15 07:32:26 +00:00			`* [Installing Connectors (Twitter/GNU Social)](help/Installing-Connectors)`
Added some more explanations about ejabberd 2015-11-20 23:09:39 +00:00			`* [Install an ejabberd server (XMPP chat) with synchronized credentials](help/install-ejabberd)`
added_new_files 2013-01-25 21:45:48 +00:00			`* [Using SSL with Friendica](help/SSL)`
Update documentation with new config style/name - Fix typos 2018-11-25 06:56:02 +00:00			`* [Config values that can only be set in config/local.config.php](help/Config)`
docu docs: some polishing 2016-12-06 14:03:57 +00:00			`* [Improve Performance](help/Improve-Performance)`
modified: doc/Home.md modified: doc/Migrate.md 2020-11-28 11:08:20 +00:00			`* [Migrate](help/Migrate)`
added dedicated documentation about tools for admins 2018-05-09 16:52:11 +00:00			`* [Administration Tools](help/tools)`
Apply suggestions from code review Co-authored-by: Hypolite Petovan <hypolite@mrpetovan.com> 2021-11-15 16:30:50 +00:00			`* [Admin FAQ](help/FAQ-admin)`
local documentation library 2011-04-13 14:07:21 +00:00
updated help's table of content 2014-12-28 15:38:19 +00:00			`Developer Manual`

Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* [Get started](help/Developers-Intro)`
			`* Set up development environment`
spelling: github Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> 2023-03-21 03:14:44 +00:00			`* [Help on GitHub](help/GitHub)`
Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* [Help on Vagrant](help/Vagrant)`
			`* [Bugs and Issues](help/Bugs-and-Issues)`
			`* Code structure`
Create documentation about Domain-Driven-Design 2020-01-05 22:55:16 +00:00			`* [Domain-Driven-Design](help/Developer-Domain-Driven-Design)`
Update docs changelog, install and doc folder 2018-01-18 00:07:07 +00:00			`* [Addon Development](help/Addons)`
Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* [Theme Development](help/themes)`
			`* [Smarty 3 Templates](help/smarty3-templates)`
Add docs about storage backend 2018-12-12 19:36:56 +00:00			`* [Storage backend addon](help/AddonStorageBackend)`
Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* How To`
			`* [Translate Friendica](help/translations)`
			`* [Use Composer](help/Composer)`
			* [Move classes to `src`](help/Developer-How-To-Move-Classes-to-src)
Add link to test doc on documentation home 2018-05-10 18:04:30 +00:00			`* [Run tests](help/Tests)`
Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* Reference`
Update link label to API page in doc home 2019-12-21 14:49:35 +00:00			`* [API endpoints](help/api)`
Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* [Code (Doxygen generated - sets cookies)](doc/html/)`
			`* [Protocol Documentation](help/Protocol)`
Update documentation with new config style/name - Fix typos 2018-11-25 06:56:02 +00:00			`* [Database schema documentation](help/database)`
Add new documentation page about moving classes to src 2017-04-30 21:34:23 +00:00			`* [Class Autoloading](help/autoloader)`
docs: add brief autoloading help page, fix smarty3 help page name 2016-02-12 08:25:33 +00:00
local documentation library 2011-04-13 14:07:21 +00:00			`External Resources`

changed links 2017-10-08 09:40:06 +00:00			`* [Main Website](https://friendi.ca)`
added ways to get some help on EN and DE landing page of the documentation 2018-02-11 09:29:30 +00:00			`* Ways to get Support`
Replace "forum" by "group" in documentation - Replace "Forum" by "Gruppe" in German documentation 2023-05-29 22:31:08 +00:00			`* Friendica Support Group: [@helpers@forum.friendi.ca](https://forum.friendi.ca/~helpers)`
use the correct markup for 2nd level list elements 2018-02-11 09:41:46 +00:00			* [Mailing List Archive](http://mailman.friendi.ca/mailman/listinfo/support-friendi.ca) you can subscribe to the list by sending an email to ``support-request(at)friendi.ca?subject=subscribe``
spelling: bridged Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> 2023-03-26 22:00:52 +00:00			`* Community chat rooms (the IRC, Matrix and XMPP rooms are bridged) these public chats are logged [from IRC](https://gnusociarg.nsupdate.info/2021/%23friendica/) and [Matrix](https://view.matrix.org/alias/%23friendi.ca:matrix.org/)`
added #friendica at libera.chat to the community chat rooms 2021-05-24 06:04:17 +00:00			`* XMPP/Jabber MUC: support(at)forum.friendi.ca`
docs, remove freenode from the IRC list 2021-08-11 15:31:33 +00:00			`* IRC: #friendica at [libera.chat](https://web.libera.chat/?channels=#friendica)`
added #friendica at libera.chat to the community chat rooms 2021-05-24 06:04:17 +00:00			`* Matrix: [#friendi.ca](https://matrix.to/#/#friendi.ca:matrix.org) or [#friendica-en](https://matrix.to/#/#friendica-en:matrix.org) at matrix.org`
local documentation library 2011-04-13 14:07:21 +00:00
expose "friendika" (about) page 2011-04-29 23:58:19 +00:00			`About`

some doc updates 2011-11-08 22:12:01 +00:00			`* [Site/Version Info](friendica)`
link the credits page from the help pages 2015-10-29 06:58:05 +00:00			`* [Friendica Credits](credits)`