WIP: Write documentation #55

Draft
tasiaiso wants to merge 22 commits from tasiaiso/tildefriends:tasiaiso-documentation into main
8 changed files with 5 additions and 10 deletions
Showing only changes of commit 912747bdac - Show all commits

View File

@ -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: <https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
Docs are a work in progress: [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md), or alternatively in Tilde Friends: <https://www.tildefriends.net/~cory/wiki/#test-wiki/tf-app-quick-reference>.
## License

View File

@ -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.

View File

@ -4,5 +4,4 @@ Quick start
Complete documentation
TODO

View File

@ -11,6 +11,3 @@ See [building.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main
### Where is my database located ?
TODO

View File

@ -1 +1 @@
TODO
# TODO

View File

@ -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 .`

View File

@ -1 +1 @@
TODO
# TODO

View File

@ -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".