From a492b019fe6e545273edd0332eb31d5fd7658314 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20N=2E=20Robalino?= Date: Wed, 25 Sep 2019 11:15:00 -0500 Subject: [PATCH] Commands documenting instructions. --- docs/commands/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/commands/README.md diff --git a/docs/commands/README.md b/docs/commands/README.md new file mode 100644 index 000000000..d3834c314 --- /dev/null +++ b/docs/commands/README.md @@ -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 +