Make use of console/Rconsole fenced code blocks

[hturner]

We should use ```console fencing to markup input/output from the terminal (ref: https://stackoverflow.com/a/49004070) and similarly ```Rconsole fencing to mark up input/output from the R Console (ref: r-devel/r-dev-day#60).

Fenced code could replace some of the text only screenshots, making the docs easier to maintain and more accessible to users of screen readers and other assistive technologies

Marking (R) console output differently from code can help to differentiate code that should be copied and run vs input/output in the console that may be copied in whole/part, but is mainly for reference (ref: #106).

[savsch]

For fencing terminal input, ```console doesn't do a good job unless there's a shell prompt (e.g. a dollar or tilde sign with some extra metadata like the current working dir in most setups) preceding the input. The below recording shows the difference between using ```bash and ```console:

fence.mp4

If we do add the prompt (at least the dollar sign), then it presents the same old problem of the copy-to-clipboard button including the shell prompt as well which might be annoying to some users. Thinking that way, ```bash fencing seems like a better option.

[hturner]

Yes, that's why I suggested this a solution for replacing screenshots of input/output rather than a replacement for existing bash/r fenced code that is intended for people to copy and paste as they work through the docs. Most, if not all, of the code chunks currently marked up as bash/r should be left unchanged.

[avinab-neogy]

Hi @hturner,
I'd like to work on this issue. To confirm my understanding: the goal is to replace text-only screenshots in the documentation with fenced code blocks—using console fencing for terminal input/output and Rconsole fencing for R console sessions. This should improve accessibility and make the docs easier to maintain.
Let me know if this is correct.
Thanks!

[hturner]

Yes @avinabneogy23 that's the idea, would be great if you could work on this issue.

In some cases a screenshot may still make sense, e.g. if it is important to see the file explorer or the plot window as well as code input and/or output. But if the purpose of the screenshot is to show input and/or output then it can be replaced by appropriately fenced code.

[savsch]

@avinabneogy23 @hturner It isn't immediately apparent, but there already exists a PR for this issue: #211. Although it isn't "linked" to this issue and is a bit rough around the edges (e.g. makes unnecessary changes to mkdocs.yml), I am unsure if competing PRs are welcome here. In fact, finding #211 after making my previous comment had prevented me from working on it.

[avinab-neogy]

@savsch right we would not want duplicate work.
I will take a look at the PR and we can discuss changes it requires according to this:

In some cases a screenshot may still make sense, e.g. if it is important to see the file explorer or the plot window as well as code input and/or output. But if the purpose of the screenshot is to show input and/or output then it can be replaced by appropriately fenced code.

Thanks @savsch for the heads up!
@hturner let us know if this is alright Heather!

[hturner]

Good point @savsch - it would be fair to give @IVedantD a chance to update their PR first of all. I will add a comment on the PR linking to this issue and we'll see where that goes.

[hturner]

Reopening this as we still would like to replace screenshots with RConsole code where that makes sense.