mirror of
https://github.com/nushell/nushell
synced 2024-12-26 04:53:09 +00:00
Commands documenting instructions.
This commit is contained in:
parent
ffa536bea3
commit
a492b019fe
1 changed files with 19 additions and 0 deletions
19
docs/commands/README.md
Normal file
19
docs/commands/README.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# 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
|
||||
|
Loading…
Reference in a new issue