Cleaned up doc titles

PurpleKingdomGames · Aug 17, 2023 · ecc7390 · ecc7390
1 parent 5a488ae
commit ecc7390
Show file tree

Hide file tree

Showing 66 changed files with 448 additions and 574 deletions.
diff --git a/indigo/docs/development-status.md → indigo/docs/README.md b/indigo/docs/development-status.md → indigo/docs/README.md
@@ -1,11 +1,10 @@
----
-id: development-status
-title: Indigo's Development Status
----
+# Indigo
 
-## Indigo's Status is Alpha
+Indigo is a pixel art Scala 2D game engine that encourages functional programming, and broadly follows the Elm architecture.
 
-Indigo will be consider in an alpha release state until a game of any significant depth is shown to have been built using it. The implication being that by successfully building at releasing a game - web or desktop - enough features and structure must have been written in order to have made that happen.
+## Indigo's Development Status
+
+Indigo is pretty stable, but will be consider in an alpha release state until a game of any significant depth is shown to have been built using it. The implication being that by successfully building and releasing a game - web or desktop - enough features and structure must have been written in order to have made that happen.
 
 If you have a game you are building and plan to release, or are building for a game jam or something, get in touch on Discord or Gitter and we _will_ help you with any technical problems if we possibly can!
 

diff --git a/indigo/docs/gameloop/README.md b/indigo/docs/gameloop/README.md
@@ -0,0 +1 @@
+# Gameloop
diff --git a/indigo/docs/gameloop/events.md b/indigo/docs/gameloop/events.md
@@ -1,7 +1,4 @@
----
-id: events
-title: Events
----
+# Events
 
 ## The event loop
 

diff --git a/indigo/docs/gameloop/frame-context.md b/indigo/docs/gameloop/frame-context.md
@@ -1,7 +1,4 @@
----
-id: frame-context
-title: Frame context
----
+# Frame context
 
 Updating a frame in Indigo is principally about doing two things:
 

diff --git a/indigo/docs/gameloop/outcome.md b/indigo/docs/gameloop/outcome.md
@@ -1,7 +1,4 @@
----
-id: outcome
-title: Outcome Type
----
+# Outcome Type
 
 ## What is an Outcome?
 

diff --git a/indigo/docs/guides.md b/indigo/docs/guides.md
diff --git a/indigo/docs/guides/README.md b/indigo/docs/guides/README.md
@@ -0,0 +1,5 @@
+# Guides
+
+In contrast to the rest of the docs, these guides are intended to be practical "how to" examples that work through specific use cases.
+
+As with all of Indigo's documentation, this section is a work in progress!
diff --git a/indigo/docs/guides/howto-custom-entity.md b/indigo/docs/guides/howto-custom-entity.md
@@ -1,7 +1,4 @@
----
-id: howto-custom-entity
-title: How to make a custom entity
----
+# How to make a custom entity
 
 ## What are custom entities?
 

diff --git a/indigo/docs/guides/howto-fire-shader.md b/indigo/docs/guides/howto-fire-shader.md
@@ -1,7 +1,4 @@
----
-id: howto-fire-shader
-title: How to write a fire shader
----
+# How to write a fire shader
 
 In this how-to guide, we're going to look at one approach to writing a little shader that produces procedural flames. Here's one I made earlier:
 
@@ -194,7 +191,7 @@ layout (std140) uniform FireData {
 };
 ```
 
-At some point in the future it would be good to improve the type safety around the relationship across this interface, but for now, please take care. More information on how this works including the **all important packing rules** can be found in the [Shaders Overview](/shaders/shader-overview.md).
+At some point in the future it would be good to improve the type safety around the relationship across this interface, but for now, please take care. More information on how this works including the **all important packing rules** can be found in the [Shaders Overview](/shaders/README.md).
 
 ### UVs
 

diff --git a/indigo/docs/guides/howto-hello-indigo-tyrian.md b/indigo/docs/guides/howto-hello-indigo-tyrian.md
@@ -1,7 +1,4 @@
----
-id: howto-responsive-ui-with-tyrian
-title: How to make a responsive UI using Tyrian
----
+# How to make a responsive UI using Tyrian
 
 ## Responsive UI Using Tyrian
 

diff --git a/indigo/docs/guides/howto-indigo-game.md b/indigo/docs/guides/howto-indigo-game.md
@@ -1,7 +1,4 @@
----
-id: howto-indigo-game
-title: Converting `IndigoSandbox` to `IndigoGame`
----
+# Converting `IndigoSandbox` to `IndigoGame`
 
 ## Basic Concepts
 

diff --git a/indigo/docs/information/README.md b/indigo/docs/information/README.md
@@ -0,0 +1 @@
+# Misc
diff --git a/indigo/docs/information/alternatives.md b/indigo/docs/information/alternatives.md
@@ -1,7 +1,4 @@
----
-id: alternatives
-title: Alternatives to Indigo
----
+# Alternatives to Indigo
 
 If Indigo isn't quite working out for you - we quite understand! Here are some possible alternatives to help you get your game dev fix. Each of these suggestions has something in common with Indigo, there are of course lots of other engines out there!
 

diff --git a/indigo/docs/information/antipatterns.md b/indigo/docs/information/antipatterns.md
@@ -1,7 +1,4 @@
----
-id: antipatterns
-title: Anti-Patterns
----
+# Anti-Patterns
 
 This page is an attempt to flag any anti-patterns, bad practices or traps that the authors have seen in the wild or have themselves fallen into! The hope is that but not repeating these mistakes your game dev'ving will be more fun and fruitful.
 

diff --git a/indigo/docs/information/glossary.md b/indigo/docs/information/glossary.md
@@ -1,25 +1,22 @@
----
-id: glossary
-title: Glossary
----
+# Glossary
 
-# A
+## A
 
 ### Automata
 
 A type of subsystem used to manage simple autonomous particles.
 
-# B
+## B
 
-# C
+## C
 
-# D
+## D
 
 ### Dice
 
 A pseudo-random number generator seeded on the current frames running time to facilitate testing and issue reproduction.
 
-# E
+## E
 
 ### Entry point
 
@@ -29,53 +26,53 @@ The main interface an Indigo game developer is exposed to when trying to write a
 
 A description of an action that is emitted during a frame and made available to the subsequent frame, such as a keyboard event.
 
-# F
+## F
 
 ### Frame Independence
 
 Movement that is adjusted to account for the time elapsed between frames in order to proceed at a consistent rate.
 
-# G
+## G
 
 ### GameTime
 
 A sample of the current time provided to every frame. All computations are assumed to happen instantly at the time given.
 
-# H
+## H
 
-# I
+## I
 
 ### InputState
 
 The current state of input devices like the keyboard, mouse or game pad.
 
-# J
+## J
 
-# K
+## K
 
-# L
+## L
 
-# M
+## M
 
-# N
+## N
 
-# O
+## O
 
 ### Outcome
 
 Used to gather state and events that were the result of a frame update.
 
-# P
+## P
 
-# Q
+## Q
 
-# R
+## R
 
 ### Referential Transparency
 
 The ability to reliably replace a function call and arguments, with the result type and observe no change.
 
-# S
+## S
 
 ### Scene
 
@@ -101,20 +98,20 @@ A combinator used to manipulate, process, and compose Signals.
 
 A small, well encapsulated game that can be combined with the main game. Used to organise sections of you game and to manages tasks and processes in the background.
 
-# T
+## T
 
 ### Time Varying Value
 
 A value that is updated automatically based on some behavior and the time delta between frames.
 
-# U
+## U
 
-# V
+## V
 
-# W
+## W
 
-# X
+## X
 
-# Y
+## Y
 
-# Z
+## Z
diff --git a/indigo/docs/information/key-concepts.md b/indigo/docs/information/key-concepts.md
@@ -1,7 +1,4 @@
----
-id: key-concepts
-title: Key Concepts
----
+# Key Concepts
 
 ## Making a game testable
 

diff --git a/indigo/docs/information/model-viewmodel-view.md b/indigo/docs/information/model-viewmodel-view.md
@@ -1,7 +1,4 @@
----
-id: model-viewmodel-view
-title: Model, ViewModel, & View
----
+# Model, ViewModel, & View
 
 The standard entry point traits define functions that talk about a `Model`, a `ViewModel`, and a "view" (in the form of a `present` function that returns a `SceneUpdateFragment`).
 

diff --git a/indigo/docs/information/motivation-and-constraints.md b/indigo/docs/information/motivation-and-constraints.md
@@ -1,7 +1,4 @@
----
-id: motivation-and-constraints
-title: Motivation & Constraints
----
+# Motivation & Constraints
 
 ## Motivation
 

diff --git a/indigo/docs/information/performance.md b/indigo/docs/information/performance.md
@@ -1,7 +1,4 @@
----
-id: performance
-title: Performance
----
+# Performance
 
 ## What is performance?
 

diff --git a/indigo/docs/information/prior-art.md b/indigo/docs/information/prior-art.md
@@ -1,7 +1,4 @@
----
-id: prior-art
-title: Prior Art
----
+# Prior Art
 
 Indigo was not built in a vacuum, it's the conflation of lots of different borrowed ideas, mostly from the places listed below. There are lots of good references on each of these subjects, but here they are briefly enumerated as areas you can dig into if you're interested.
 

diff --git a/indigo/docs/information/rendering-technology.md b/indigo/docs/information/rendering-technology.md
@@ -1,7 +1,4 @@
----
-id: rendering-technology
-title: Rendering Technology
----
+# Rendering Technology
 
 At the time of writing, there are five options for rendering 2D graphics into a browser page, if you are so inclined:
 

diff --git a/indigo/docs/organisation/README.md b/indigo/docs/organisation/README.md
@@ -0,0 +1 @@
+# Organisation
diff --git a/indigo/docs/organisation/boot-and-start-up.md b/indigo/docs/organisation/boot-and-start-up.md
@@ -1,7 +1,4 @@
----
-id: boot-and-start-up
-title: Boot & Start Up
----
+# Boot & Start Up
 
 > Please note that the terms "start up" and "setup" are used interchangeably here. "Startup" is the name of the data type, while "setup" is the name of the method. This naming should probably be revisited...
 

diff --git a/indigo/docs/organisation/game-entry-points.md b/indigo/docs/organisation/game-entry-points.md
@@ -1,7 +1,4 @@
----
-id: game-entry-points
-title: Game Entry Points
----
+# Game Entry Points
 
 Entry points are typically traits that you extend in order to write your game, and they provide the basic structure that you need to adhere to, to make a game that Indigo understands. What they actually do underneath is provide a user friendly way to build the frame processor and start the engine that does all of the work.
 

diff --git a/indigo/docs/platform/README.md b/indigo/docs/platform/README.md
@@ -0,0 +1,3 @@
+# Platform
+
+Information on interacting with the outside world.
diff --git a/indigo/docs/platform/assets.md b/indigo/docs/platform/assets.md
@@ -1,7 +1,4 @@
----
-id: assets
-title: Assets & Asset Loading
----
+# Assets & Asset Loading
 
 ## Asset Types
 

diff --git a/indigo/docs/platform/cross-platform-publishing.md b/indigo/docs/platform/cross-platform-publishing.md
@@ -1,7 +1,4 @@
----
-id: cross-platform-publishing
-title: Cross Platform Publishing
----
+# Cross Platform Publishing
 
 Indigo supports basic publishing to/building for the following platforms:
 

diff --git a/indigo/docs/platform/importers.md b/indigo/docs/platform/importers.md
@@ -1,7 +1,4 @@
----
-id: importers
-title: File Format Importers
----
+# File Importers
 
 At the time of writing, Indigo has limited support for importing data from Aseprite and Tiled. The support that has been added was built on an "as needed" basis, and is far from complete.
 

diff --git a/indigo/docs/platform/input-handling.md b/indigo/docs/platform/input-handling.md
@@ -1,7 +1,4 @@
----
-id: input-handling
-title: User Input Handling
----
+# Input Handling
 
 At the time of writing, Indigo understands three input device types: Mouse, Keyboard, and Gamepad.
 

diff --git a/indigo/docs/platform/loading-and-saving-data.md b/indigo/docs/platform/loading-and-saving-data.md
@@ -1,7 +1,4 @@
----
-id: loading-and-saving-data
-title: Loading & Saving Data
----
+# Loading & Saving Data
 
 Sooner or later, you're probably going to need to load data into your game or save user data.
 

diff --git a/indigo/docs/platform/logging.md b/indigo/docs/platform/logging.md
@@ -1,7 +1,4 @@
----
-id: logging
-title: Logging
----
+# Logging
 
 Sometimes you need a log message to help you debug something, and to help you do that Indigo comes with a very simple / border-line dumb logger.