From bf5009293d8fde644b641aacc60ba5788f0ce7fb Mon Sep 17 00:00:00 2001 From: Jordan Bancino Date: Thu, 29 Sep 2022 18:16:16 -0400 Subject: [PATCH] Update docs --- TODO.txt | 7 +++++++ docs/telodendria.7 | 14 +++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/TODO.txt b/TODO.txt index 5e34131..4753469 100644 --- a/TODO.txt +++ b/TODO.txt @@ -73,6 +73,7 @@ Phase 3: Welcome to Matrix Phase 4: [ ] Create an OpenBSD package and get it submitted to ports +[ ] Add relayd examples to contrib/ [ ] Create a command line tool to manage Telodendria [ ] Configuration file generation [ ] User management @@ -100,3 +101,9 @@ Documentation [x] Clean up dark mode in man page CSS (links) [x] Synopsis table should not be styled [ ] Internal API docs + +[ ] Add onboarding documentation + [ ] Building from source + [ ] Writing config file + [ ] Setting up chroot + [ ] Setting up relayd diff --git a/docs/telodendria.7 b/docs/telodendria.7 index b48042b..019124d 100644 --- a/docs/telodendria.7 +++ b/docs/telodendria.7 @@ -1,4 +1,4 @@ -.Dd $Mdocdate: September 27 2022 $ +.Dd $Mdocdate: September 29 2022 $ .Dt TELODENDRIA 7 .Os Telodendria Project .Sh NAME @@ -98,13 +98,13 @@ To implement the latest Matrix specification as fully and completely as possible All features defined by the specification should eventually be present in .Nm . .It -To be a production-ready Matrix server capable of handling a lot of users. +To be a production-ready Matrix server capable of working in constrained environments, +such as embedded devices, cheap VPSs, or a peer-to-peer device. +.Nm +should also work on traditional setups as well, and be able to handle a decent +amount of users. It should work well for personal Matrix homeservers that also +host a few friends and/or family members. .Nm -should have good performance in many diverse environments. It should scale up -well for large instances, such as the -.Pa matrix.org -instance, and yet also be able to scale down to an embedded or peer-to-peer -device. .It To be easier to get up and running, and yet also be more configurable than other Matrix homeserver implementations. The configuration file should be flexible,