Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2025-01-26 11:55:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

More command documentation instructions.

Browse source
This commit is contained in:
Andrés N. Robalino 2019-09-25 11:35:58 -05:00 committed by GitHub
parent 440f553aa8
commit f85968aba4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/commands/README.md
View file

@ -1,6 +1,6 @@
# How do I get started? # How do I get started?
Pick any command from the checklist and write a comment acknowleding you started work. Pick any command from the checklist and write a comment acknowledging you started work.
# Instructions for documenting a Nu command of your choosing # Instructions for documenting a Nu command of your choosing
@ -8,12 +8,18 @@ Name the file after the command, like so:
`command.md` `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. Example: If you want to add documentation for the Nu command `enter`, create a file named `enter.md`, write documentation, save it at `/docs/commands/[your_command_picked].md` as and create your pull request.
# What kind of documentation should I write? # 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): 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!) * Examples of using the command (max creativity welcomed!)
* Description of the command * Description of the command.
* Command usage.
# Anything else?
Of course! (These are drafts) so feel free to leave feedback and suggestions in the same file.
Happy Documenting.