render scenario description as markdown

src/Swarm/Doc/Pedagogy.hs

@@ -39,7 +39,7 @@ import Swarm.Game.World.Load (loadWorlds)
 import Swarm.Language.Module (Module (..))
 import Swarm.Language.Pipeline (ProcessedTerm (..))
 import Swarm.Language.Syntax
-import Swarm.Language.Text.Markdown (findCode)
+import Swarm.Language.Text.Markdown (docToText, findCode)
 import Swarm.Language.Types (Polytype)
 import Swarm.TUI.Controller (getTutorials)
 import Swarm.Util.Effect (ignoreWarnings, simpleErrorHandle)
@@ -175,7 +175,7 @@ renderUsagesMarkdown (CoverageInfo (TutorialInfo (s, si) idx _sCmds dCmds) novel
     intercalate
       [""]
       [ pure . surround "`" . T.pack $ view scenarioPath si
-      , pure . surround "*" . T.strip $ view scenarioDescription s
+      , pure . surround "*" . T.strip . docToText $ view scenarioDescription s
       , renderSection "Introduced in solution" . renderCmdList $ M.keysSet novelCmds
       , renderSection "Referenced in description" $ renderCmdList dCmds
       ]

src/Swarm/Game/Scenario.hs

@@ -77,6 +77,8 @@ import Swarm.Game.Universe
 import Swarm.Game.World.Typecheck (WorldMap)
 import Swarm.Language.Pipeline (ProcessedTerm)
 import Swarm.Language.Pretty (prettyText)
+import Swarm.Language.Syntax (Syntax)
+import Swarm.Language.Text.Markdown (Document)
 import Swarm.Util (binTuples, failT)
 import Swarm.Util.Effect (throwToMaybe, withThrow)
 import Swarm.Util.Lens (makeLensesNoSigs)
@@ -94,7 +96,7 @@ data Scenario = Scenario
   { _scenarioVersion :: Int
   , _scenarioName :: Text
   , _scenarioAuthor :: Maybe Text
-  , _scenarioDescription :: Text
+  , _scenarioDescription :: Document Syntax
   , _scenarioCreative :: Bool
   , _scenarioSeed :: Maybe Int
   , _scenarioAttrs :: [CustomAttr]
@@ -203,7 +205,7 @@ scenarioAuthor :: Lens' Scenario (Maybe Text)
 
 -- | A high-level description of the scenario, shown /e.g./ in the
 --   menu.
-scenarioDescription :: Lens' Scenario Text
+scenarioDescription :: Lens' Scenario (Document Syntax)
 
 -- | Whether the scenario should start in creative mode.
 scenarioCreative :: Lens' Scenario Bool

src/Swarm/TUI/Editor/Json.hs

@@ -7,11 +7,13 @@ import Data.Yaml as Y
 import GHC.Generics (Generic)
 import Swarm.Game.Entity (Entity)
 import Swarm.Game.Scenario.Topography.WorldDescription
+import Swarm.Language.Syntax (Syntax)
+import Swarm.Language.Text.Markdown (Document)
 
 data SkeletonScenario = SkeletonScenario
   { version :: Int
   , name :: Text
-  , description :: Text
+  , description :: Document Syntax
   , creative :: Bool
   , entities :: [Entity]
   , world :: WorldDescriptionPaint

src/Swarm/TUI/Editor/Palette.hs

@@ -29,6 +29,7 @@ import Swarm.Game.Scenario.Topography.Navigation.Portal (Navigation (..))
 import Swarm.Game.Scenario.Topography.WorldPalette
 import Swarm.Game.Terrain (TerrainType, getTerrainDefaultPaletteChar)
 import Swarm.Game.Universe
+import Swarm.Language.Text.Markdown (fromText)
 import Swarm.TUI.Editor.Json (SkeletonScenario (SkeletonScenario))
 import Swarm.Util (binTuples, histogram)
 import Swarm.Util qualified as U
@@ -116,7 +117,7 @@ constructScenario maybeOriginalScenario cellGrid =
   SkeletonScenario
     (maybe 1 (^. scenarioVersion) maybeOriginalScenario)
     (maybe "My Scenario" (^. scenarioName) maybeOriginalScenario)
-    (maybe "The scenario description..." (^. scenarioDescription) maybeOriginalScenario)
+    (maybe (fromText "The scenario description...") (^. scenarioDescription) maybeOriginalScenario)
     -- (maybe True (^. scenarioCreative) maybeOriginalScenario)
     True
     (M.elems $ entitiesByName customEntities)

src/Swarm/TUI/View.hs

@@ -237,7 +237,7 @@ drawNewGameMenuUI (l :| ls) launchOptions = case displayedFor of
   drawDescription (SICollection _ _) = txtWrap " "
   drawDescription (SISingle (s, si)) =
     vBox
-      [ txtWrap (nonBlank (s ^. scenarioDescription))
+      [ drawMarkdown (nonBlank (s ^. scenarioDescription))
       , padTop (Pad 1) table
       ]
    where