diff --git a/Doxyfile b/Doxyfile index f3ba7d3a..cdc07abc 100644 --- a/Doxyfile +++ b/Doxyfile @@ -907,7 +907,6 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = README.md \ - core/app.js \ core/client.js \ core/core.js \ core/tfrpc.js \ diff --git a/docs/app_development.md b/docs/app_development.md new file mode 100644 index 00000000..54bd78a9 --- /dev/null +++ b/docs/app_development.md @@ -0,0 +1,4 @@ +@page app_development App Development + +- @subpage app_development_cheat_sheet +- @subpage app_development_guide diff --git a/docs/app_development_cheat_sheet.md b/docs/app_development_cheat_sheet.md index 55d8a745..cd30de2d 100644 --- a/docs/app_development_cheat_sheet.md +++ b/docs/app_development_cheat_sheet.md @@ -1,4 +1,4 @@ -# App Development Cheat Sheet +@page app_development_cheat_sheet App Development Cheat Sheet Making apps for the impatient tilde friend. diff --git a/docs/app_development_guide.md b/docs/app_development_guide.md index 4d368e59..a23bea95 100644 --- a/docs/app_development_guide.md +++ b/docs/app_development_guide.md @@ -1,4 +1,4 @@ -# App Development Guide +@page app_development_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/connecting_manyverse.md b/docs/connecting_manyverse.md index 0becbf9b..de902542 100644 --- a/docs/connecting_manyverse.md +++ b/docs/connecting_manyverse.md @@ -1,3 +1,5 @@ +@page connecting_manyverse How to Connect Manyverse + # Connecting with Manyverse Communication with [Manyverse](https://www.manyver.se/) should Just Work (tm). diff --git a/docs/howto.md b/docs/howto.md new file mode 100644 index 00000000..9bf50614 --- /dev/null +++ b/docs/howto.md @@ -0,0 +1,5 @@ +@page howto How To + +- @subpage upgrading +- @subpage transfer_account +- @subpage connecting_manyverse diff --git a/docs/inspiration.md b/docs/inspiration.md index d3071311..f0ee312a 100644 --- a/docs/inspiration.md +++ b/docs/inspiration.md @@ -1,4 +1,4 @@ -# Inspiration +@page inspiration Inspiration This is an ever-growing list of software that is similar to what Tilde Friends tries to be but as far as I can tell don't quite fit the same niche. diff --git a/docs/model.md b/docs/model.md index 40ec6352..49a2f0e8 100644 --- a/docs/model.md +++ b/docs/model.md @@ -1,4 +1,4 @@ -# Model +@page model Model A reasonable mental model of Tilde Friends is as a virtual computer. User interace is through a web browser. Communication with the outside world is diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 00000000..4142d5ea --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,5 @@ +@page overview Overview + +- @subpage inspiration +- @subpage model +- @subpage vision diff --git a/docs/transfer_account.md b/docs/transfer_account.md index 99f09ee6..b6001277 100644 --- a/docs/transfer_account.md +++ b/docs/transfer_account.md @@ -1,4 +1,4 @@ -# How to Transfer an Account +@page transfer_account How to Transfer an Account Secure Scuttlebutt accounts can be easily transferred between apps and devices. diff --git a/docs/upgrading.md b/docs/upgrading.md index 14103c8d..d53b57ac 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -1,4 +1,4 @@ -# Upgrading +@page upgrading Upgrading Tilde Friends can be upgraded simply by running a new executable against an existing database. diff --git a/docs/vision.md b/docs/vision.md index 4d67fbff..fbf967ca 100644 --- a/docs/vision.md +++ b/docs/vision.md @@ -1,4 +1,4 @@ -# Vision +@page vision Vision Tilde Friends is a tool for making and sharing.