diff --git a/Doxyfile b/Doxyfile index 809a7bdc..9e298157 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1051,7 +1051,7 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = +IMAGE_PATH = docs/images/ # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program diff --git a/docs/connecting_manyverse.md b/docs/connecting_manyverse.md new file mode 100644 index 00000000..0becbf9b --- /dev/null +++ b/docs/connecting_manyverse.md @@ -0,0 +1,40 @@ +# Connecting with Manyverse + +Communication with [Manyverse](https://www.manyver.se/) should Just Work (tm). + +This document is intended as a cheat sheet for the instances where it doesn't. +If your experience differs, please share so we can make things better. + +## Connecting Manyverse to the tildefriends.net room + +Open the `Connections` tab. This is from the desktop app, but mobile is similar. + +![Manyverse connections tab](manyverse_connections_tab.png) + +Open the `Connections Panel`. + +![Manyverse connections panel](manyverse_connections_panel.png) + +Use the `Add Connection` button at the bottom right to open the dialog to enter +a connections string to add a new connection. + +![Manyverse connections panel](manyverse_paste_invite_code.png) + +Copy the tildefriends.net room code from https://www.tildefriends.net/~cory/room/. + +![Tilde Friends room code](tildefriends_room_app.png) + +Paste. + +On mobile especially, make sure the full text is pasted without modification. + +![Manyverse invite code](manyverse_code.png) + +Click `Done`, and you should be connected successfully. tildefriends.net is +all things: a room, a pub, and a client, so you should be able to start replicating +immediately as well as find other similarly connected people with whom to establish +further connections. + +When logged into tildefriends.net, active connections it sees can be found on +the `Connections` tab: https://www.tildefriends.net/~core/ssb/#connections, +which may indicate errors if you find yourself disconnecting. diff --git a/docs/images/manyverse_code.png b/docs/images/manyverse_code.png new file mode 100644 index 00000000..188d0251 Binary files /dev/null and b/docs/images/manyverse_code.png differ diff --git a/docs/images/manyverse_connections_panel.png b/docs/images/manyverse_connections_panel.png new file mode 100644 index 00000000..7bee555c Binary files /dev/null and b/docs/images/manyverse_connections_panel.png differ diff --git a/docs/images/manyverse_connections_tab.png b/docs/images/manyverse_connections_tab.png new file mode 100644 index 00000000..b19a2425 Binary files /dev/null and b/docs/images/manyverse_connections_tab.png differ diff --git a/docs/images/manyverse_paste_invite_code.png b/docs/images/manyverse_paste_invite_code.png new file mode 100644 index 00000000..990d23ee Binary files /dev/null and b/docs/images/manyverse_paste_invite_code.png differ diff --git a/docs/images/tildefriends_room_app.png b/docs/images/tildefriends_room_app.png new file mode 100644 index 00000000..ebdb0453 Binary files /dev/null and b/docs/images/tildefriends_room_app.png differ