Replace outdated examples with new narrative-driven system monitoring and progress examples; add comprehensive markup syntax reference and related resources.

Author: phil-scott-78

Spectre.Docs.Examples/Showcase/LiveSample.cs

@@ -2,69 +2,59 @@
 
 namespace Spectre.Docs.Examples.Showcase;
 
-/// <summary>Demonstrates progress bars with multiple tasks.</summary>
+/// <summary>Demonstrates multi-task progress tracking for deployments.</summary>
 public class ProgressSample : BaseSample
 {
     /// <inheritdoc />
     public override void Run(IAnsiConsole console)
     {
-        // Show progress
         console.Progress()
             .AutoClear(false)
-            .Columns(new TaskDescriptionColumn(), new ProgressBarColumn(), new PercentageColumn(), new RemainingTimeColumn(), new SpinnerColumn())
+            .Columns(
+                new TaskDescriptionColumn(),
+                new ProgressBarColumn(),
+                new PercentageColumn(),
+                new RemainingTimeColumn(),
+                new SpinnerColumn())
             .Start(ctx =>
             {
-                var random = new Random(122978);
+                var random = new Random(42);
 
-                // Create some tasks
-                var tasks = CreateTasks(ctx, random);
-                var warpTask = ctx.AddTask("Going to warp", autoStart: false).IsIndeterminate();
+                var tasks = new List<(ProgressTask Task, double Speed)>
+                {
+                    (ctx.AddTask("Reticulating splines"), random.NextDouble() * 2 + 1.1),
+                    (ctx.AddTask("Hydrating caches"), random.NextDouble() * 2 + 1),
+                    (ctx.AddTask("Consulting the oracle"), random.NextDouble() * 2 + 1.2),
+                    (ctx.AddTask("Negotiating with upstream"), random.NextDouble() * 2 + 1.05),
+                    (ctx.AddTask("Defenestrating legacy code"), random.NextDouble() * 2 + 1.4),
+                };
+
+                var launchTask = ctx.AddTask("Preparing for descent", autoStart: false);
+                launchTask.IsIndeterminate();
 
-                // Wait for all tasks (except the indeterminate one) to complete
                 while (!ctx.IsFinished)
                 {
-                    // Increment progress
-                    foreach (var (task, increment) in tasks)
+                    foreach (var (task, speed) in tasks)
                     {
-                        task.Increment(random.NextDouble() * increment);
+                        if (!task.IsFinished)
+                        {
+                            task.Increment(random.NextDouble() * speed);
+                        }
                     }
 
-                    // Simulate some delay
-                    Thread.Sleep(100);
-                }
+                    if (tasks.All(t => t.Task.IsFinished) && !launchTask.IsStarted)
+                    {
+                        launchTask.StartTask();
+                        launchTask.IsIndeterminate(false);
+                    }
 
-                // Now start the "warp" task
-                warpTask.StartTask();
-                warpTask.IsIndeterminate(false);
-                while (!ctx.IsFinished)
-                {
-                    warpTask.Increment(12 * random.NextDouble());
+                    if (launchTask is { IsStarted: true, IsFinished: false })
+                    {
+                        launchTask.Increment(random.NextDouble() * 3 + 1);
+                    }
 
-                    // Simulate some delay
-                    Thread.Sleep(100);
+                    Thread.Sleep(80);
                 }
             });
     }
-
-    /// <summary>Creates sample progress tasks.</summary>
-    /// <param name="progress">The progress context.</param>
-    /// <param name="random">Random generator for delays.</param>
-    /// <returns>List of tasks with their delay values.</returns>
-    public List<(ProgressTask Task, int Delay)> CreateTasks(ProgressContext progress, Random random)
-    {
-        var tasks = new List<(ProgressTask, int)>();
-
-        var names = new[]
-        {
-            "Retriculating algorithms", "Colliding splines", "Solving quarks", "Folding data structures",
-            "Rerouting capacitators "
-        };
-
-        for (var i = 0; i < 5; i++)
-        {
-            tasks.Add((progress.AddTask(names[i]), random.Next(2, 10)));
-        }
-
-        return tasks;
-    }
-}
+}

Spectre.Docs.Examples/Showcase/ProgressSample.cs

@@ -2,66 +2,49 @@
 
 namespace Spectre.Docs.Examples.Showcase;
 
-internal class StatusSample : BaseSample
+/// <summary>Demonstrates status spinner for data processing operations.</summary>
+public class StatusSample : BaseSample
 {
-    private static void WriteLogMessage(string message)
-    {
-        AnsiConsole.MarkupLine($"[grey]LOG:[/] {message}[grey]...[/]");
-    }
-
+    /// <inheritdoc />
     public override void Run(IAnsiConsole console)
     {
         console.Status()
-            .AutoRefresh(true)
-            .Spinner(Spinner.Known.Default)
-            .Start("[yellow]Initializing warp drive[/]", ctx =>
+            .Spinner(Spinner.Known.Dots)
+            .SpinnerStyle(Style.Parse("blue"))
+            .Start("Waking up the hamsters...", ctx =>
             {
-                // Initialize
-                Thread.Sleep(3000);
-                WriteLogMessage("Starting gravimetric field displacement manifold");
                 Thread.Sleep(1000);
-                WriteLogMessage("Warming up deuterium chamber");
-                Thread.Sleep(2000);
-                WriteLogMessage("Generating antideuterium");
 
-                // Warp nacelles
-                Thread.Sleep(3000);
-                ctx.Spinner(Spinner.Known.BouncingBar);
-                ctx.Status("[bold blue]Unfolding warp nacelles[/]");
-                WriteLogMessage("Unfolding left warp nacelle");
-                Thread.Sleep(2000);
-                WriteLogMessage("Left warp nacelle [green]online[/]");
-                WriteLogMessage("Unfolding right warp nacelle");
-                Thread.Sleep(1000);
-                WriteLogMessage("Right warp nacelle [green]online[/]");
+                ctx.Status("[blue]Locating remote endpoints...[/]");
+                ctx.Spinner(Spinner.Known.Dots2);
+                Thread.Sleep(1200);
 
-                // Warp bubble
-                Thread.Sleep(3000);
-                ctx.Spinner(Spinner.Known.Star2);
-                ctx.Status("[bold blue]Generating warp bubble[/]");
-                Thread.Sleep(3000);
+                ctx.Status("[cyan]Convincing firewall...[/]");
                 ctx.Spinner(Spinner.Known.Star);
-                ctx.Status("[bold blue]Stabilizing warp bubble[/]");
+                ctx.SpinnerStyle(Style.Parse("cyan"));
+                Thread.Sleep(1000);
+
+                ctx.Status("[green]Parsing reluctant data...[/]");
+                ctx.Spinner(Spinner.Known.Arrow3);
+                ctx.SpinnerStyle(Style.Parse("green"));
+                Thread.Sleep(1400);
 
-                // Safety
-                ctx.Spinner(Spinner.Known.Monkey);
-                ctx.Status("[bold blue]Performing safety checks[/]");
-                WriteLogMessage("Enabling interior dampening");
-                Thread.Sleep(2000);
-                WriteLogMessage("Interior dampening [green]enabled[/]");
+                ctx.Status("[yellow]Coercing legacy formats...[/]");
+                ctx.Spinner(Spinner.Known.BouncingBar);
+                ctx.SpinnerStyle(Style.Parse("yellow"));
+                Thread.Sleep(1200);
 
-                // Warp!
-                Thread.Sleep(3000);
-                ctx.Spinner(Spinner.Known.Moon);
-                WriteLogMessage("Preparing for warp");
+                ctx.Status("[magenta]Untangling dependencies...[/]");
+                ctx.Spinner(Spinner.Known.Pipe);
+                ctx.SpinnerStyle(Style.Parse("magenta"));
+                Thread.Sleep(1100);
+
+                ctx.Status("[green bold]Archiving for posterity...[/]");
+                ctx.Spinner(Spinner.Known.Dots12);
+                ctx.SpinnerStyle(Style.Parse("green bold"));
                 Thread.Sleep(1000);
-                for (var warp = 1; warp < 10; warp++)
-                {
-                    ctx.Status($"[bold blue]Warp {warp}[/]");
-                    Thread.Sleep(500);
-                }
             });
 
-        // Done
-        AnsiConsole.MarkupLine("[bold green]Crusing at Warp 9.8[/]");        }
-}
+        console.MarkupLine("[green]Data ingestion complete.[/] [dim]2,847.3 records processed.[/]");
+    }
+}

Spectre.Docs.Examples/Showcase/StatusSample.cs

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 18
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build align"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase align"

Spectre.Docs.Examples/VCR/align.tape

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 16
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build bar-chart"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase bar-chart"

Spectre.Docs.Examples/VCR/bar-chart.tape

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 14
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build breakdown-chart"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase breakdown-chart"

Spectre.Docs.Examples/VCR/breakdown-chart.tape

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 16
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build calendar"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase calendar"

Spectre.Docs.Examples/VCR/calendar.tape

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 16
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build canvas"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase canvas"

Spectre.Docs.Examples/VCR/canvas.tape

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 16
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build columns"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase columns"

Spectre.Docs.Examples/VCR/columns.tape

@@ -8,4 +8,4 @@ Set Cols 82
 Set Rows 16
 Set EndBuffer 5s
 
-Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build figlet"
+Exec "dotnet run --project .\Spectre.Docs.Examples\ --no-build showcase figlet"