spectreconsole / spectreconsole/website

Getting Started: Handle Dynamic Content Tutorial Missing Code example for MarkupLineInterpolated

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
5
Forks
7
PR merge metrics
No merged PRs in 30d

Description

The "Handle Dynamic Content" section of the getting started guide has a copy paste bug here:

https://github.com/spectreconsole/website/blob/a9091a2d16ef65855e2aca6ff3744dd88f4415cc/Spectre.Docs/Content/console/tutorials/getting-started-building-rich-console-app.md?plain=1#L131-L137

It's duplicating the example above it for the documentation link (modified in this commit: https://github.com/spectreconsole/website/commit/bcfdb99e96ad4b915eb67770a276c3b3f6536503).

It looks like in the corresponding code file for the tutorial the method meant to be shown here was never added: https://github.com/spectreconsole/website/blob/main/Spectre.Docs.Examples/SpectreConsole/Tutorials/GettingStartedTutorial.cs

So, it's not just a quick fix of putting in the proper name, the actual sample code to demonstrate this feature is missing. (I'm also not sure if the linked to https://spectreconsole.net/console/widgets/markup page for the Markup Widget has an example either? [There's no reference to MarkupLineInterpolated on that page.])

(For my understanding, I'm trying to understand if using MarkupLineInterpolated is reactive, so if I update the filename or something later that the displayed text changes automatically? Otherwise what's different than just passing the templated string into the standard method?)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Handle Dynamic Content section in Spectre.Docs/Content/console/tutorials/getting-started-building-rich-console-app.md and compare it with Spectre.Docs.Examples/SpectreConsole/Tutorials/GettingStartedTutorial.cs. Inspect the linked Markup Widget page for related coverage. Done means the guide uses a correct MarkupLineInterpolated example, the corresponding sample code exists, and the feature's behavior is explained clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.