[Enhancement]: rm all $ so users can copy-paste easily into their terminal

Open
#328 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
bash
Domain
documentation

Research direction

Start with src/content/docs/en/developers/guides/running-a-scroll-node.mdx, the example named in the issue, and search the documentation for bash snippets whose prompt lines begin with $. Remove those prompt symbols from the relevant snippets and verify that the displayed commands can be copied and pasted directly into a Linux terminal.

Written by the indexing model from the issue text.

Description

enhancement
What would you like us to improve?

allow users to directly copy bash snippets from the website and paste them on linux.
This is done by removing all the $ symbols at the beginning of each lines of the snippets. Otherwise, users get $: command not found

Its it not that much work a simple crtl + f and its done !
One example here for src/content/docs/en/developers/guides/running-a-scroll-node.mdx

How important it is?

Not that much important but very quick to do and great ux improvement

Dominant language
MDX
Stars
701
Forks
196
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from scroll-tech/scroll-documentation

All issues in scroll-tech/scroll-documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.