nushell / nushell/nushell.github.io
Improve Documentation on how to persist aliases
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
In the docs https://www.nushell.sh/book/aliases.html there is this statement:
For more details about how to persist aliases so that they're visible when you start up Nushell, see the configuration chapter.
However, if you click on that configuration chapter link and then search the page, you only see a small confusing snippet of a nuopen override example for MacOS, and nowhere else does it show how to persist aliases.
echo $nu.scope.aliases does work to show current aliases made in a session, but there should be a way to persist them much more easily somehow?
Contributor guide
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
Start with the aliases.html page and follow its link to configuration.html. Compare the existing guidance and examples for persistent aliases, then update the documentation so a reader can find the relevant instructions and verify that the link leads to useful information.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100