mirror of
https://github.com/nushell/nushell
synced 2025-01-14 14:14:13 +00:00
20 lines
725 B
Markdown
20 lines
725 B
Markdown
|
# How do I get started?
|
||
|
|
|
||
|
|
Pick any command from the checklist and write a comment acknowleding you started work.
|
||
|
|
|
||
|
|
# Instructions for documenting a Nu command of your choosing
|
||
|
|
|
||
|
|
Name the file after the command, like so:
|
||
|
|
|
||
|
|
`command.md`
|
||
|
|
|
||
|
|
Example: If you want to add documentation for the Nu command `enter`, create a file named `enter.md`, write documentation, save and create your pull request.
|
||
|
|
|
||
|
|
# What kind of documentation should I write?
|
||
|
|
|
||
|
|
Anything you want that you believe it *best* documents the command and the way you would like to see it. Here are some of our ideas of documentation we would *love* to see (feel free to add yours):
|
||
|
|
|
||
|
|
* Examples of using the command (max creativity welcomed!)
|
||
|
|
* Description of the command
|
||
|
|
|