From f85968aba41ea62ecae4cf255d17a6c112d72fd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20N=2E=20Robalino?= Date: Wed, 25 Sep 2019 11:35:58 -0500 Subject: [PATCH] More command documentation instructions. --- docs/commands/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/commands/README.md b/docs/commands/README.md index d3834c3141..68ef658cae 100644 --- a/docs/commands/README.md +++ b/docs/commands/README.md @@ -1,6 +1,6 @@ # 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 @@ -8,12 +8,18 @@ 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. +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? 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 +* 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.