Commit graph libervia-backend/doc/components.rst
Author SHA1 Message Date
Goffi
6f347a3fb1 doc (components): Documentation for the new Conferences component:
fix 445
2024-07-05 17:18:37 +02:00
Goffi
5a0a68e358 doc (components/AP Gateway): document new http_sign_get configuration option. 2024-06-05 22:34:43 +02:00
Goffi
7e3834a5e9 refactoring: fix names in doc following modules hierarchy refactoring 2023-06-02 17:38:37 +02:00
Goffi
6a6f15707a massive refactoring to switch from camelCase to snake_case:
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
2023-04-08 13:54:42 +02:00
Goffi
5eae9dc299 doc (components): typo 2022-11-22 11:53:31 +01:00
Goffi
14eac027d8 doc (components/AP Gateway): html_redirect_dict option 2022-11-11 13:51:22 +01:00
Goffi
6eac59dc2d doc (components/AP Gateway): Ad-Hoc and Events:
New Ad-Hoc command is explained, and `Events` section specify how the conversion is done
between the 2 protocols.

fix 372
2022-09-22 12:03:12 +02:00
Goffi
84e6d9ceb2 doc (components/AP gateway): "reactions":
fix 371
2022-08-31 17:07:03 +02:00
Goffi
c7acfc1b9f doc (components): the word "handle" is more adapted here 2022-08-31 17:07:03 +02:00
Goffi
6bb76a2bd0 doc (components/AP gateway): "repeat" and "noticed/like":
fix 370
2022-07-22 17:40:03 +02:00
Goffi
3633997ec4 doc (components/AP): Mention:
fix 369
2022-07-10 16:15:44 +02:00
Goffi
ebed317c3b doc (components/AP): identity and avatar:
fix 368
2022-06-29 14:23:16 +02:00
Goffi
f9eb48d72d doc (components): AP item retraction + blocking:
fix 367
2022-06-17 15:50:34 +02:00
Goffi
5ecca19b71 doc (components): typo/spelling 2022-06-17 14:15:23 +02:00
Goffi
5191343a40 doc (components): message delivery documentation:
fix 366
2022-05-24 17:57:41 +02:00
Goffi
a59ddef97c doc (components): update AP gateway documentation:
add documentation for:
    - Publishing an Item
    - Following, Subscribing and Cache
    - Following/Followers Collections and Public Pubsub Subscription

fix 365
2022-05-13 19:34:12 +02:00
Goffi
44906f3bc3 doc (components): documentation of comments_max_depth option and threads conversion:
ActivityPub to XMPP threads conversion is detailed.

fix 364
2022-03-22 17:00:42 +01:00
Goffi
a8ec84f3ec doc (components): update AP component documentation:
- add `configuration` section
- update instructions on AP actor handle <=> JID/node conversion
- explain how to get AP messages from XMPP
- explain how to get XMPP items for AP
- notes to explain tricks and implementations details

fix 363
2022-01-31 18:35:52 +01:00
Goffi
aa4e6004e8 doc (components): base documentation for AP Gateway:
fix: 362
2021-09-26 16:41:58 +02:00
Goffi
8c9af32d56 doc: components documentation:
rel 362
2021-09-26 16:38:00 +02:00