1
0
forked from cory/tildefriends

docs: Minor cleanup/normalization.

This commit is contained in:
Cory McWilliams 2025-02-03 12:39:23 -05:00
parent 0f8cbdac57
commit aca25be86a
8 changed files with 5 additions and 16 deletions

@ -68,8 +68,7 @@ privileges. Further administration can be done at
## Documentation ## Documentation
Docs are a work in progress: Docs live here: <https://docs.tildefriends.net/>.
<https://dev.tildefriends.net/cory/tildefriends/wiki>.
## License ## License

@ -1,7 +0,0 @@
# Tilde Friends
- [Home](Home)
- [Vision](Vision)
- [Inspiration](Inspiration)
- App Development
- [Guide](App-Development-Guide)
- [Cheat Sheet](App-Development-Cheat-Sheet)

@ -1,4 +1,4 @@
# Tilde Friends Cheat Sheet # App Development Cheat Sheet
Making apps for the impatient tilde friend. Making apps for the impatient tilde friend.
@ -47,7 +47,7 @@ Making apps for the impatient tilde friend.
Stock helper code for calling functions across the web server and browser boundary. Stock helper code for calling functions across the web server and browser boundary.
- on the server: `import * as tfrpc from "/tfrpc.js";` - on the server: `import * as tfrpc from "/tfrpc.js";`
- in the browser: `import * as tfrpc from "/static\/tfrpc.js";` - in the browser: `import * as tfrpc from "/static/tfrpc.js";`
- either direction: - either direction:
- register a function: `tfrpc.register(function my_function() {});` - register a function: `tfrpc.register(function my_function() {});`
- call a remote function: `let promise = tfrpc.rpc.my_function();` - call a remote function: `let promise = tfrpc.rpc.my_function();`

@ -1,4 +1,4 @@
# Tilde Friends Developer's Guide # App Development Guide
A Tilde Friends application starts with code that runs on a Tilde Friends server, possibly far away from where you wrote it, in a little JavaScript environment, in its own restricted process, with the only access to the outside world being the ability to send messages to the server. This document gives some recipes showing how that can be used to build a functional user-facing application in light of the unique constraints present. A Tilde Friends application starts with code that runs on a Tilde Friends server, possibly far away from where you wrote it, in a little JavaScript environment, in its own restricted process, with the only access to the outside world being the ability to send messages to the server. This document gives some recipes showing how that can be used to build a functional user-facing application in light of the unique constraints present.

@ -1,3 +0,0 @@
# Tilde Friends Documentation
This is the index.

@ -1,4 +1,4 @@
# Tilde Friends Vision # Vision
Tilde Friends is a tool for making and sharing. Tilde Friends is a tool for making and sharing.