From 912747bdac0e376a2f1222a3aa18b6f3ab9c2dbe Mon Sep 17 00:00:00 2001 From: Tasia Iso Date: Fri, 17 May 2024 08:21:28 +0200 Subject: [PATCH] docs: formatting --- README.md | 2 +- docs/apps/quickstart.md | 1 - docs/apps/tfrpc.md | 1 - docs/faq.md | 3 --- docs/guidelines/c-guidelines.md | 2 +- docs/guidelines/documentation-guidelines.md | 2 +- docs/guidelines/javascript-guidelines.md | 2 +- docs/running.md | 2 +- 8 files changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e17226e7..5ff0f029 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ It is both a peer-to-peer social network client, participating in Secure Scuttle ## Documentation -Docs are a work in progress in the `docs` folder, or alternatively in Tilde Friends: . +Docs are a work in progress: [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md), or alternatively in Tilde Friends: . ## License diff --git a/docs/apps/quickstart.md b/docs/apps/quickstart.md index f0caa433..e1cb6a05 100644 --- a/docs/apps/quickstart.md +++ b/docs/apps/quickstart.md @@ -32,7 +32,6 @@ main(); Save the app, and you should now be seeing `Hello world!` on the screen. - ## Components Once your app grows to a certain size, you'll want to introduce components. diff --git a/docs/apps/tfrpc.md b/docs/apps/tfrpc.md index 44edd211..ea7257e6 100644 --- a/docs/apps/tfrpc.md +++ b/docs/apps/tfrpc.md @@ -4,5 +4,4 @@ Quick start Complete documentation - TODO diff --git a/docs/faq.md b/docs/faq.md index ca5d5ea5..eae31179 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -11,6 +11,3 @@ See [building.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main ### Where is my database located ? TODO - - - diff --git a/docs/guidelines/c-guidelines.md b/docs/guidelines/c-guidelines.md index 1333ed77..46409041 100644 --- a/docs/guidelines/c-guidelines.md +++ b/docs/guidelines/c-guidelines.md @@ -1 +1 @@ -TODO +# TODO diff --git a/docs/guidelines/documentation-guidelines.md b/docs/guidelines/documentation-guidelines.md index 8afdf20a..71e7c641 100644 --- a/docs/guidelines/documentation-guidelines.md +++ b/docs/guidelines/documentation-guidelines.md @@ -57,7 +57,7 @@ The documentation should therefore be acessible and usefule to most people inter 3. Commands SHOULD start with a caret: (is that the tehnical term ?) - - `$` if the command should be run as the current user + - `$` if the command should be run as the current user - `#` if the command should be run as root > Example: To build in docker, `$ docker build .` diff --git a/docs/guidelines/javascript-guidelines.md b/docs/guidelines/javascript-guidelines.md index 1333ed77..46409041 100644 --- a/docs/guidelines/javascript-guidelines.md +++ b/docs/guidelines/javascript-guidelines.md @@ -1 +1 @@ -TODO +# TODO diff --git a/docs/running.md b/docs/running.md index 718b1c9d..5a0d1830 100644 --- a/docs/running.md +++ b/docs/running.md @@ -24,7 +24,7 @@ Enter your username and password. Next, create a Scuttlebutt identity by pressing the "Create an identity" button. This will create a pair of keys that are used to sign your messages with. -Because of the way Scuttlebutt is designed, you cannot log into your account without your keys. +Because of the way Scuttlebutt is designed, you cannot log into your account without your keys. Tilde Friends locks your keys behind a password, but if you were to destroy your database, the keys would be gone forever, and with it your possibility to send messages using this account. Click on the `identity` app and under "Identities", export your newly created identity. You'll be prompted with a dialog box saying "This app is requesting the following permission:ssb_id_export".