Merge branch 'main' into recommend-cabal

swarm-game · May 5, 2024 · ec46604 · ec46604
2 parents 9fc1f3f + 0a001a6
commit ec46604
Show file tree

Hide file tree

Showing 12 changed files with 8 additions and 8 deletions.
diff --git a/app/doc/Swarm/Doc/Schema/Render.hs b/app/doc/Swarm/Doc/Schema/Render.hs
@@ -37,7 +37,7 @@ scenariosDir :: FilePath
 scenariosDir = "data/scenarios"
 
 docFragmentsDir :: FilePath
-docFragmentsDir = scenariosDir </> "doc-fragments"
+docFragmentsDir = scenariosDir </> "_doc-fragments"
 
 schemasDir :: FilePath
 schemasDir = "data/schema"
@@ -148,7 +148,7 @@ genScenarioSchemaDocs = do
     schemaTuples <- except $ traverse sequenceA xs
     things <- liftIO $ mapM loadFooterContent schemaTuples
     myMarkdown <- except $ genMarkdown things
-    docHeader <- liftIO $ TIO.readFile "data/scenarios/doc-fragments/header.md"
+    docHeader <- liftIO $ TIO.readFile "data/scenarios/_doc-fragments/header.md"
     liftIO . writeFile (docFragmentsDir </> "SCHEMA.md") . T.unpack $ docHeader <> myMarkdown
 
   case result of

diff --git a/data/scenarios/README.md b/data/scenarios/README.md
@@ -72,4 +72,4 @@ scripts/validate/json-schemas.sh
 
 ### YAML schema
 
-See the autogenerated [`SCHEMA.md`](doc-fragments/SCHEMA.md).
+See the autogenerated [`SCHEMA.md`](_doc-fragments/SCHEMA.md).
diff --git a/data/scenarios/doc-fragments/SCHEMA.md → data/scenarios/_doc-fragments/SCHEMA.md b/data/scenarios/doc-fragments/SCHEMA.md → data/scenarios/_doc-fragments/SCHEMA.md
diff --git a/data/scenarios/doc-fragments/base-robot.md → data/scenarios/_doc-fragments/base-robot.md b/data/scenarios/doc-fragments/base-robot.md → data/scenarios/_doc-fragments/base-robot.md
diff --git a/data/scenarios/doc-fragments/capabilities.md → .../scenarios/_doc-fragments/capabilities.md b/data/scenarios/doc-fragments/capabilities.md → .../scenarios/_doc-fragments/capabilities.md
diff --git a/data/scenarios/doc-fragments/cells.md → data/scenarios/_doc-fragments/cells.md b/data/scenarios/doc-fragments/cells.md → data/scenarios/_doc-fragments/cells.md
diff --git a/...narios/doc-fragments/entity-properties.md → ...arios/_doc-fragments/entity-properties.md b/...narios/doc-fragments/entity-properties.md → ...arios/_doc-fragments/entity-properties.md
diff --git a/data/scenarios/doc-fragments/header.md → data/scenarios/_doc-fragments/header.md b/data/scenarios/doc-fragments/header.md → data/scenarios/_doc-fragments/header.md
diff --git a/data/schema/entity.json b/data/schema/entity.json
@@ -4,8 +4,8 @@
     "title": "Entity",
     "description": "Description of an entity in the Swarm game",
     "footers": [
-        "doc-fragments/entity-properties.md",
-        "doc-fragments/capabilities.md"
+        "_doc-fragments/entity-properties.md",
+        "_doc-fragments/capabilities.md"
     ],
     "type": "object",
     "additionalProperties": false,

diff --git a/data/schema/robot.json b/data/schema/robot.json
@@ -4,7 +4,7 @@
     "title": "Robot",
     "description": "Description of a robot in the Swarm game",
     "footers": [
-        "doc-fragments/base-robot.md"
+        "_doc-fragments/base-robot.md"
     ],
     "type": "object",
     "additionalProperties": false,

diff --git a/data/schema/world.json b/data/schema/world.json
@@ -4,7 +4,7 @@
     "title": "World",
     "description": "Description of the world in the Swarm game",
     "footers": [
-        "doc-fragments/cells.md"
+        "_doc-fragments/cells.md"
     ],
     "type": "object",
     "additionalProperties": false,

diff --git a/src/swarm-scenario/Swarm/Game/Scenario/Topography/Structure/Recognition/Precompute.hs b/src/swarm-scenario/Swarm/Game/Scenario/Topography/Structure/Recognition/Precompute.hs
@@ -6,7 +6,7 @@
 -- = Search process overview
 --
 -- 2D structures may be defined at the
--- <https://github.com/swarm-game/swarm/blob/main/data/scenarios/doc-fragments/SCHEMA.md#top-level toplevel of a scenario file>.
+-- <https://github.com/swarm-game/swarm/blob/main/data/scenarios/_doc-fragments/SCHEMA.md#top-level toplevel of a scenario file>.
 -- Upon scenario load, all of the predefined structures that are marked
 -- as @"recognize"@ are compiled into searcher state machines.
 --