From bb5ea463163c9a1f312e69b00a534d07861be822 Mon Sep 17 00:00:00 2001 From: Ted Unangst Date: Tue, 23 Apr 2019 16:32:37 -0400 Subject: [PATCH] some updates to documentation --- docs/manual.txt | 11 +++++++++++ docs/spec.txt | 7 +++++++ 2 files changed, 18 insertions(+) diff --git a/docs/manual.txt b/docs/manual.txt index bb8bcc8..63b1604 100644 --- a/docs/manual.txt +++ b/docs/manual.txt @@ -1,6 +1,12 @@ Instructions for running of the honk. +-- posting + +Should work as expected. Supports **bold** and *italics*. + +Large images are rescaled and reduced. + -- following In order to follow somebody, you need to enter one of two identifiers. @@ -12,6 +18,8 @@ Alternatively, one may directly enter the actor ID, which is a URL that looks like https://example.com/users/name. Note that the commonly seen URL with @name in it is not their actor ID and won't work. +Followed honkers may be assigned to combos, listing all their honks together. + Selecting just peeping won't actually follow them. (Incomplete feature.) -- zonking @@ -21,6 +29,9 @@ those of others that you're tired of seeing. This reduces its visibility, but doesn't attempt to delete it, which is infeasible. It's more like disavow. +The killzone supports blocking unwanted contacts. One may block an actor +(zonker), a domain (zurl), or thread (zonvoy). + -- privacy Honks are public. Welcome to the internet. diff --git a/docs/spec.txt b/docs/spec.txt index cc46ba7..3a53a60 100644 --- a/docs/spec.txt +++ b/docs/spec.txt @@ -18,6 +18,13 @@ If a message can't be delivered, we backoff and retry. A random drift of up to 10% is added to each delay to avoid swarming. +-- federating + +Messages are transformed for federation and display. Some transformations +occur send side and some occur receive client because it's more exciting that +way. @mentions and *markdown* are converted to HTML before transmission. +Message :emoji: are converted to inline images after receiving. + -- schema Some notes on the database schema. Mostly for development, but maybe useful