oppia / oppia/oppia-web-developer-docs
[BUG]: Installation guide: `$` prompt in terminal commands causes copy-paste confusion on macOS terminal
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18
- Forks
- 134
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
While following the local installation guide on macOS (Apple Silicon),
I noticed that some terminal commands are shown with a leading $.
When copy-pasting these commands directly into the macOS Terminal,
the $ causes an error since the shell already displays a '$' before every prompt.
As a first-time contributor, this was confusing and made setup harder.
URL of the page where the issue is observed.
https://github.com/oppia/oppia/wiki/Installing-Oppia-%28Mac-OS%3B-Python-3%29
Steps To Reproduce
- Open the Oppia repository on GitHub.
- Navigate to the local installation / developer setup guide.
- On macOS, open the Terminal application.
- Copy a command from the installation guide that includes a leading
$. - Paste the command directly into the Terminal and press Enter.
- Observe that the command fails because
$is treated as part of the command instead of a prompt.
Expected Behavior
The installation guide should present terminal commands in a copy-pastable format.
Ideally:
-
Command input should be shown without the shell prompt (
$). -
Command output should be displayed separately and not included in the copy-pastable command block.
-
Terminal commands and their outputs should be clearly separated in the installation guide.
For example, commands like: $ arch $ arch -x86_64 $SHELL --login $ arch should be written as separate, copy-pastable lines without the shell prompt (`$`). Any output produced by these commands (such as `arm64` or `i386`) should be shown separately and not included in the copyable command block. This separation would reduce confusion and prevent users from accidentally copying outputs or shell prompts into the terminal.
Screenshots/Videos
What device are you using?
Desktop
Operating System
MacOS
What browsers are you seeing the problem on?
Chrome
Browser version
Version 143.0.7499.170 (Official Build) (arm64)
Additional context
-Because the command prompt, command, and output appear together in the same block,
copy-pasting the entire block causes the terminal to interpret the output lines
as part of the command itself.
-This results in errors that are confusing for beginners, since the terminal
does not distinguish between intended command input and displayed output when pasted.
Tips for developers
Before addressing the bug, please identify which PR caused the issue (you can follow the steps here). If you identify the PR, comment on the issue with a link to it. If not, mention the commit hash of the oldest commit you saw the bug on (and the month and year it was made in).
Then, please leave a comment with details of the approach that you plan to take to fix the issue (see example).
Note: If this is your first Oppia issue, please make sure to follow our guidelines for choosing an issue and setting things up. You will also need to show a demo of the fix working correctly on your local machine. Thanks!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the Installing Oppia (Mac OS; Python 3) wiki page from the issue and inspect the terminal command blocks, especially the arch examples. Remove leading shell prompts from copyable commands and separate outputs such as arm64 or i386, then verify that each command can be pasted independently without including prompt or output text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- macos, shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100