Merge pull request #13 from rivet-gg/feature/svc-2565

Improve internal docs

.github/workflows/links.yaml

@@ -0,0 +1,14 @@
+name: link-checker
+
+on: [push]
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Link Checker
+      uses: lycheeverse/lychee-action@v1.8.0
+      with:
+        fail: true

README.md

@@ -9,8 +9,8 @@
 <p align="center">
   <img alt="GitHub" src="https://img.shields.io/github/license/rivet-gg/rivet?style=flat-square">
   <a href='http://makeapullrequest.com'><img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square'/></a>
-  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/rivet/rivet?style=flat-square"/>
-  <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/rivet/rivet?style=flat-square"/>
+  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/rivet-gg/rivet?style=flat-square"/>
+  <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/rivet-gg/rivet?style=flat-square"/>
 </p>
 
 <p align="center">
@@ -24,7 +24,7 @@
 - [Serverless Lobbies](https://docs.rivet.gg/serverless-lobbies/introduction) for auto-scaling game lobbies
 - [Flexible matchmaker](https://docs.rivet.gg/matchmaker/introduction) for placing players in lobbies with no wait times
 - [CDN](https://docs.rivet.gg/cdn/introduction) for hosting assets and webpages with a custom domain or provided rivet.game subdomain
-- [Game Guard](https://docs.rivet.gg/serverless-lobbies/concepts/game-guard) for DDoS mitigation and managed WebSocket SSL & TCP+TLS termination
+- [Game Guard](https://docs.rivet.gg/serverless-lobbies/concepts/game-guard) for DDoS mitigation and managed WebSocket SSL, TCP+TLS, and UDP
 - Streamlined DevOps for teams
 - Unified logging & monitoring & analytics
 - No downtime deploys with easy rollbacks
@@ -41,47 +41,34 @@
 
 ### Self-hosting
 
-See the [setup guide](./doc/SETUP.md) to develop & deploy Rivet yourself.
+See the [setup guide](/docs/getting_started/DEVELOPMENT.md) to develop & deploy Rivet yourself.
 
 ## 📐 Architecture
 
 Below is a simplified architecture diagram of a Rivet cluster.
 
-![Architecture](./media/simplified_architecture.png)
+![Architecture](/media/simplified_architecture.png)
 
-## 📖 Helpful Docs
+## 📖 Documentation Overview
 
 > **Looking for documentation on building a game with Rivet?**
 > 
 > Visit our [documentation for game developers](https://docs.rivet.gg/)!
 
-**Core Components**
+**Getting Started**
 
--   [Project Structure](/doc/PROJECT_STRUCTURE.md)
--   [Bolt](/doc/bolt/README.md)
--   [Chirp](/doc/chirp/README.md)
+- [Project Structure](/docs/getting_started/PROJECT_STRUCTURE.md)
+- [Developing on Rivet](/docs/getting_started/DEVELOPMENT.md)
+- [Error Handling](/docs/libraries/chirp/ERROR_HANDLING.md)
 
-**Operating a Rivet Cluster**
+**Philosophy**
 
--   [Developing Services](/doc/DEVELOPING_SERVICES.md)
--   [Working with Databases](/doc/WORKING_WITH_DATABASES.md)
--   [Terraform](/doc/tf/README.md)
--   [SaltStack](/doc/saltstack/README.md)
+- [Why open source](/docs/philosophy/WHY_OPEN_SOURCE.md)
 
-**3rd Party Services**
+**Architecture**
 
--   Databases
-    -   [Cockroach](/doc/cockroach/README.md)
-    -   [ClickHouse](/doc/clickhouse/README.md)
-    -   [Redis](/doc/redis/README.md)
--   Infrastructure
-    -   [Nomad](/doc/nomad/README.md)
-    -   [Consul](/doc/consul/README.md)
-    -   [Traefik](/doc/traefik/README.md)
-    -   [Nebula](/doc/nebula/README.md)
--   Development
-    -   [Nix](/doc/nix/README.md)
+- [Software Bill of Materials](/docs/infrastructure/SBOM.md)
 
-**Writing services**
+**About**
 
--   [Error Handling](/doc/ERROR_HANDLING.md)
+- [Notable missing features](/docs/about/MISSING_FEATURES.md)