Compare commits

...

4 Commits

Author SHA1 Message Date
1b3b9e570e
add result to gitignore 2024-05-23 13:12:10 +02:00
912747bdac
docs: formatting 2024-05-17 08:21:28 +02:00
80c1463a5c
docs: fix links 2024-05-17 08:16:51 +02:00
f2a3c790dd
docs: issue & pr templates draft 2024-05-17 08:12:46 +02:00
16 changed files with 34 additions and 18 deletions

View File

@ -0,0 +1,3 @@
---
name: 'Bug Report'
---

View File

@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md
about: Read the documentation

View File

@ -0,0 +1,3 @@
---
name: 'Feature Request'
---

View File

@ -0,0 +1,9 @@
To Do List
- [ ] My changes are documented in the [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/index.md)
- [ ] I have tested my changes
- [ ] I agree to the contribution guidelines
- [ ] [C](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/c-guidelines.md)
- [ ] [JavaScript](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/javascript-guidelines.md)
- [ ] [documentation](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/documentation-guidelines.md)
<!-- - [ ] I agree to the [Code of Conduct]() -->

1
.gitignore vendored
View File

@ -8,4 +8,5 @@ out
*.swo *.swo
*.swp *.swp
.zsign_cache/ .zsign_cache/
result
NOTES.md NOTES.md

View File

@ -14,7 +14,7 @@ It is both a peer-to-peer social network client, participating in Secure Scuttle
## Documentation ## 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 ## License

View File

@ -32,7 +32,6 @@ main();
Save the app, and you should now be seeing `Hello world!` on the screen. Save the app, and you should now be seeing `Hello world!` on the screen.
## Components ## Components
Once your app grows to a certain size, you'll want to introduce components. Once your app grows to a certain size, you'll want to introduce components.
@ -49,6 +48,6 @@ TODO: tfrpc
Apps can interact with Tilde Friends using tfrpc. Apps can interact with Tilde Friends using tfrpc.
Read <tfrpc.md> Read [tfrpc.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/apps/tfrpc.md)
TODO: sharing apps TODO: sharing apps

View File

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

View File

@ -41,7 +41,7 @@ To build in docker, `docker build .`
<!-- On NixOS: TODO --> <!-- On NixOS: TODO -->
<!-- Add shell.nix and nix derivs first --> <!-- Add shell.nix and nix derivs first -->
Now that you have a binary, head over to <running.md>. Now that you have a binary, head over to [running.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/running.md).
## Troubleshooting ## Troubleshooting

View File

@ -38,7 +38,7 @@ TODO
- I want to write documentation ! - I want to write documentation !
Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation. Great! Before you do, have a look at the [documentation guidelines](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
In all cases: In all cases:

View File

@ -2,12 +2,12 @@
## Building ## Building
See <building.md>. See [building.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/building.md).
## Contibuting ## Contibuting
See <contributing.md>. See [contributing.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/contributing.md).
## FAQ / Troubleshooting ## FAQ / Troubleshooting
See <faq.md>. See [faq.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/faq.md).

View File

@ -2,15 +2,12 @@
## I started tildefriends. Now what ? ## I started tildefriends. Now what ?
See <running.md>. See [running.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/running.md).
### The compiler throws an error and I can't build the binary ### The compiler throws an error and I can't build the binary
See <building.md>. See [building.md](https://dev.tildefriends.net/cory/tildefriends/src/branch/main/docs/building.md).
### Where is my database located ? ### Where is my database located ?
TODO 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 ?) 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 - `#` if the command should be run as root
> Example: To build in docker, `$ docker build .` > 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. 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. 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. 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". You'll be prompted with a dialog box saying "This app is requesting the following permission:ssb_id_export".