Basic Description of Planned Projects (#19)

* Add a basic description of planned projects * Create index.md * Link to docs; remove from readme
DevChatter · Nov 23, 2022 · ba77e0b · ba77e0b
1 parent dc4c19f
commit ba77e0b
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,10 @@ To run the WebApp, you can navigate to the `\WebApp` folder from your preferred
 dotnet run watch
 ```
 
+## Project Documentation
+
+For information about the project, see the [Smilodon Documentation](https://devchatter.github.io/Smilodon)
+
 ## Primary Contributors
 
 ### Brendan Enrick (@Brendoneus)

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,24 @@
+
+## Smilodon Docs
+
+This project is just starting, so the docs are incomplete. 
+
+## Project Components
+
+The Codename "Smilodon" Project contains a few projects.
+
+### Web API Project
+
+The WebApp project exposes the REST API, which includes the [ActivityPub](https://activitypub.rocks/) Endpoint and a [WebFinger](https://webfinger.net/) Endpoint. It's built using AspNetCore on .NET 7. Having this separate from the Web Streaming allows them to scale separately.
+
+### Web Streaming Project
+
+The WebStreaming project handles the real-time updates and other long-running connections using web sockets. Having this separate from the Web API allows them to scale separately.
+
+### Background Processing Project
+
+TBD - Most likely a .NET 7 process of some kind.
+
+### Database
+
+TBD - Most likely a Postgres database compatible with the schema used by Mastodon, so that switching a server to/from Mastodon is easy.