nushell / nushell/nushell.github.io
Use cookbook to explain some nu_scripts
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
Currently, the cookbook is rather underwhelming. The idea of the cookbook is to show practical recipes and how-to guides with explanations. One idea how to add more content is to take some nice script from nu_scripts and go through it in detail in a cookbook page. This has two benefits:
- Enhanced in-depth documentation for scripts in nu_scripts
- More cookbook content
Of course, we can think of other scripts to add to nu_scripts that would be interesting to cover in the cookbook.
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 the existing cookbook pages and the linked nu_scripts repository to understand the current coverage. Identify a suitable script and outline a detailed cookbook guide around it. Done means adding a practical page that explains the script and provides an in-depth how-to, while improving documentation for the covered script.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100