Complete the "Language Reference Guide"
Open
Nobody has claimed this yet.
category:enhancement
status:needs-triage
- Dominant language
- Rust
- Stars
- 40.5k
- Forks
- 2.3k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 79
Description
Basics
- I have done a basic search through the issue tracker to find similar or related issues.
- I have made myself familiar with the available features of Nushell for the particular area this enhancement request touches.
Related problem
I am trying to learn more about Nushell via the website's documentation, and this guide is very sparse, with many pages only having a "TODO".
Describe the solution you'd like
Fill out the guide with relevant documentation. Its doesn't need to be perfectly thorough, but it at least needs to explain the basics.
Describe alternatives you've considered
Ask an LLM to teach me Nushell.
Additional context and details
No response
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 by reviewing Nushell's Language Reference Guide at https://www.nushell.sh/lang-guide/ and identify the pages that still contain TODO. Expand the guide with explanations of Nushell's basics; done means the sparse sections have relevant introductory documentation rather than TODO placeholders.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100