From aca25be86acef6878695590c7adac69179d5c466 Mon Sep 17 00:00:00 2001 From: Cory McWilliams Date: Mon, 3 Feb 2025 12:39:23 -0500 Subject: [PATCH] docs: Minor cleanup/normalization. --- README.md | 3 +-- docs/_Sidebar.md | 7 ------- ...pment-Cheat-Sheet.md => app_development_cheat_sheet.md} | 4 ++-- .../{App-Development-Guide.md => app_development_guide.md} | 2 +- docs/index.md | 3 --- docs/{Inspiration.md => inspiration.md} | 0 docs/{Release-Checklist.md => release_checklist.md} | 0 docs/{Vision.md => vision.md} | 2 +- 8 files changed, 5 insertions(+), 16 deletions(-) delete mode 100644 docs/_Sidebar.md rename docs/{App-Development-Cheat-Sheet.md => app_development_cheat_sheet.md} (95%) rename docs/{App-Development-Guide.md => app_development_guide.md} (99%) delete mode 100644 docs/index.md rename docs/{Inspiration.md => inspiration.md} (100%) rename docs/{Release-Checklist.md => release_checklist.md} (100%) rename docs/{Vision.md => vision.md} (99%) diff --git a/README.md b/README.md index c33b4d5e..39624d8a 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,7 @@ privileges. Further administration can be done at ## Documentation -Docs are a work in progress: -. +Docs live here: . ## License diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md deleted file mode 100644 index f0434628..00000000 --- a/docs/_Sidebar.md +++ /dev/null @@ -1,7 +0,0 @@ -# Tilde Friends -- [Home](Home) -- [Vision](Vision) -- [Inspiration](Inspiration) -- App Development - - [Guide](App-Development-Guide) - - [Cheat Sheet](App-Development-Cheat-Sheet) diff --git a/docs/App-Development-Cheat-Sheet.md b/docs/app_development_cheat_sheet.md similarity index 95% rename from docs/App-Development-Cheat-Sheet.md rename to docs/app_development_cheat_sheet.md index cdb8c23f..55d8a745 100644 --- a/docs/App-Development-Cheat-Sheet.md +++ b/docs/app_development_cheat_sheet.md @@ -1,4 +1,4 @@ -# Tilde Friends Cheat Sheet +# App Development Cheat Sheet 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. - 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: - register a function: `tfrpc.register(function my_function() {});` - call a remote function: `let promise = tfrpc.rpc.my_function();` diff --git a/docs/App-Development-Guide.md b/docs/app_development_guide.md similarity index 99% rename from docs/App-Development-Guide.md rename to docs/app_development_guide.md index 383a0bd1..4d368e59 100644 --- a/docs/App-Development-Guide.md +++ b/docs/app_development_guide.md @@ -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. diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index a21ff9e3..00000000 --- a/docs/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Tilde Friends Documentation - -This is the index. diff --git a/docs/Inspiration.md b/docs/inspiration.md similarity index 100% rename from docs/Inspiration.md rename to docs/inspiration.md diff --git a/docs/Release-Checklist.md b/docs/release_checklist.md similarity index 100% rename from docs/Release-Checklist.md rename to docs/release_checklist.md diff --git a/docs/Vision.md b/docs/vision.md similarity index 99% rename from docs/Vision.md rename to docs/vision.md index 5d74f80b..4d67fbff 100644 --- a/docs/Vision.md +++ b/docs/vision.md @@ -1,4 +1,4 @@ -# Tilde Friends Vision +# Vision Tilde Friends is a tool for making and sharing.