cory/tildefriends
4
5
Fork 1
Code Issues 33 Pull Requests 1 Actions Releases 27 Wiki Activity

WIP: Write documentation #55

Draft
tasiaiso wants to merge 22 commits from tasiaiso/tildefriends:tasiaiso-documentation into main
pull from: tasiaiso/tildefriends:tasiaiso-documentation
merge into: cory:main
Conversation 0 Commits 22 Files Changed 25 +26 -4
4 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit d7eda01c16 - Show all commits

4
docs/building.md
View File

@ -45,7 +45,7 @@ Now that you have a binary, head over to <running.md>.
## Troubleshooting
### The compiler throws an error and I can't build the binary
### The compiler throws a warning and I can't build the binary
You can choose to tell the compiler to ignore warnings.
Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
@ -75,4 +75,4 @@ CFLAGS += \
```
Now the compiler will ignore this error and *should* continue building anyways.
This is a dirty hack to get Tilde Friends to compile and you should not propose to keep this flag on. Instead, open a bug report.
Note this is a dirty hack to get Tilde Friends to compile and you should not propose to keep this flag on. Instead, open a bug report.

10
docs/contributing.md
View File

@ -1,5 +1,15 @@
# How to contribute
## Philosophy
TODO
## Best practices
TODO
## How to get your changes merged
- Fork this repository
- Clone your repository

8
docs/guidelines/documentation-guidelines.md
View File

@ -47,7 +47,7 @@ The documentation should therefore be acessible and usefule to most people inter
You MAY use one line per sentence.
2. Lines ending with an `inline code block` SHOULD NOT end with a period to make copy-pasting easier.
2. Lines ending with an `inline code block` or hyperlinks SHOULD NOT end with a period to make copy-pasting easier.
> Example: To build in docker, `$ docker build .`
@ -67,3 +67,9 @@ More TODO
## License
As per the rest of the code in this repository, the documentation is shared under the [MIT](https://opensource.org/licenses/MIT/) license.
## Changelog
### v1 (2024-05-12)
First version; 3 new guidelines.

8
docs/in-depth.md
View File

@ -1,5 +1,4 @@
# Tilde Friends in depth
# Tilde Friends
## Philosophy
@ -29,3 +28,10 @@ The core process runs a core set of scripts that implement a web server, typical
Only the core process has access to most system resources, but session processes can be given accesss through the core process.
Service processes are identical to session processes, but they are not tied to a user session.
```text
/-------\ /-------------\ /--------------\
| C app | <-----> | Server-side | <-----> | Client-side |
| | tfrpc | JS runtime | | JS (Browser) |
\-------/ \-------------/ \--------------/
```