First pass at updating all documentation formatting and cleaning up output of examples (#2031)

This commit is contained in:
Joseph T. Lyons
2020-06-23 14:21:47 -04:00
committed by GitHub
parent d095cb91e4
commit 053bd926ec
81 changed files with 1069 additions and 679 deletions

View File

@@ -2,7 +2,7 @@
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
Name the file after the command, like so:
@@ -10,7 +10,7 @@ Name the file after the command, like so:
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):
@@ -18,7 +18,7 @@ Anything you want that you believe it *best* documents the command and the way y
* Description of the command.
* Command usage.
# Anything else?
## Anything else?
Of course! (These are drafts) so feel free to leave feedback and suggestions in the same file.