Code snippets in developer docs should work when copied #3224
Assignees
Labels
docs
Documentation issues
Comments
flowstef
added a commit
that referenced
this issue
Nov 6, 2020
8 tasks
mergify bot
added a commit
that referenced
this issue
Nov 9, 2020
Fixed #3224 leaving example code blocks intact
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
Most code snippets in the developer docs (as opposed to all other docs) are prefixed with
$, indicating they are supposed to be executed on the command line.Product
FlowKit main docs
Version
ea012c1
To Reproduce
Go to https://flowkit.xyz/developer/dev_environment_setup/, copy one of the commands and paste into your command line.
Expected behavior
When pasting, it should not have a leading
$as this makes the command fail.Additional context
The
$indicates it is a command and makes sense to be contained in longer code snippets that consist of multiple commands where it acts as a visual indicator/separator for individual commands.The text was updated successfully, but these errors were encountered: