Skip to content

Editorial Work on Shell Documentation #778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jun 4, 2025
Merged

Conversation

juleskerley
Copy link
Collaborator

Did a bunch of updates on the Shell Documentation to fix typos, readability issues, and update documentation.

Overall, the goal was to make the documentation easier to read and understand.

Some of this is subjective. Feel free to make edits or undo changes as you see fit.

Copy link
Collaborator

@yandthj yandthj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New changes look good except for one change requested

# Uncomment the following line if you don't like systemctl's auto-paging feature:
# export SYSTEMD_PAGER=

# User specific aliases and functions
```

This just runs the system version of bashrc.
First, you will see that this runs the system's version of the bashrc from /etc/; the purpose is to initialize system-wide functions and aliases. Second, note that it sets up the user specific environment by setting PATH to `$HOME/.local/bin:$HOME/bin:$PATH`; in short, this adds the user's executables to the PATH if those executables are in either `$HOME/.local/bin` or `$HOME/bin`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good except we're missing an explanation of what the PATH variable is. The page used to have this explanation "PATH points to directories where the computer will look for commands to run. You can append directories as show here."

@yandthj yandthj merged commit f0f3f87 into NREL:gh-pages Jun 4, 2025
@juleskerley juleskerley deleted the editing branch June 4, 2025 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants