Create index pages for documentation (#82)

The documentation files have been slightly restructured to enable an index page. This avoid 404 errors when a user removes part of the URL to get to the index of the docs.
jdno · Apr 13, 2022 · 1caef89 · 1caef89
1 parent 85b578a
commit 1caef89
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![GitHub branch checks state](https://img.shields.io/github/checks-status/jdno/atc/main)](https://github.com/jdno/atc/actions)
 
 [Homepage](https://auto-traffic-control.com) |
-[Documentation](https://auto-traffic-control.com/docs/getting-started) |
+[Documentation](https://auto-traffic-control.com/docs) |
 [Community](https://github.com/jdno/auto-traffic-control/discussions)
 
 **Auto Traffic Control** is a video game played by programming. The player's

diff --git a/docs/docs/api/introduction.md → docs/docs/api/index.md b/docs/docs/api/introduction.md → docs/docs/api/index.md
@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+title: Introduction
 ---
 
 # Introduction

diff --git a/docs/docs/getting-started.md → docs/docs/index.md b/docs/docs/getting-started.md → docs/docs/index.md
@@ -1,4 +1,8 @@
-# Getting Started
+---
+title: Quickstart
+---
+
+# Quickstart
 
 ## 👋 Welcome
 
@@ -92,7 +96,7 @@ a connection to the server, you can start playing the game by sending the
 
 Have fun exploring the game!
 
-[getting started]: /docs/getting-started
+[getting started]: /docs
 [github]: https://github.com/jdno/auto-traffic-control
 [grpc]: https://grpc.io/
 [itch.io]: https://itch.io

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -51,13 +51,13 @@ const config = {
         items: [
           {
             type: "doc",
-            docId: "getting-started",
+            docId: "index",
             position: "left",
             label: "Docs",
           },
           {
             type: "doc",
-            docId: "api/introduction",
+            docId: "api/index",
             position: "left",
             label: "API",
           },

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -13,7 +13,7 @@
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
-  docs: ["getting-started", "rules"],
+  docs: ["index", "rules"],
   api: [
     {
       type: "autogenerated",

diff --git a/docs/src/pages/index.md b/docs/src/pages/index.md
@@ -11,7 +11,7 @@ freely practice programming. The game provides a language-agnostic
 [gRPC] API, giving players free choice of programming language or paradigm.
 
 :::tip
-Check out the [Getting Started](/docs/getting-started) guide to start playing.
+Check out the [Getting Started](/docs) guide to start playing.
 :::
 
 ## Features

diff --git a/sdk/rust/README.md b/sdk/rust/README.md
@@ -5,7 +5,7 @@
 [![Crates.io](https://img.shields.io/crates/l/auto-traffic-control)](https://crates.io/crates/auto-traffic-control)
 
 [Homepage](https://auto-traffic-control.com) |
-[Documentation](https://auto-traffic-control.com/docs/getting-started) |
+[Documentation](https://auto-traffic-control.com/docs) |
 [Community](https://github.com/jdno/auto-traffic-control/discussions)
 
 **Auto Traffic Control** is a video game played by programming. The player's