mirror of https://github.com/nushell/nushell.git synced 2025-04-05 08:09:20 +02:00

History

Jonathan Turner 51879d022e Merge pull request #895 from Flare576/substring Adds new substring function to str plugin		2019-11-02 17:42:45 +13:00
..
add.md
average.md	fix typos and incorrect commands	2019-10-18 20:43:37 -04:00
cd.md	Add documentation for `cd -`	2019-10-08 18:32:42 +11:00
date.md
echo.md
edit.md
enter.md	Add documentation for the enter command	2019-10-07 23:21:58 +08:00
env.md
exit.md
fetch.md
first.md
from-csv.md	Create docs for from-csv command	2019-10-25 20:40:51 +02:00
from-toml.md	Create docs for from-toml command	2019-10-25 20:47:00 +02:00
help.md
inc.md
last.md
lines.md
nth.md
open.md
README.md
reverse.md
shells.md
sort-by.md	added Docs for sort-by command	2019-10-21 17:59:20 +02:00
str.md	Updated Doc, error on bad input	2019-11-01 17:25:08 -05:00
sum.md	fix typos and incorrect commands	2019-10-18 20:43:37 -04:00
sys.md
tags.md	Add documentation for tags command	2019-11-01 00:08:24 -04:00
to-csv.md
to-json.md
to-toml.md
to-tsv.md
to-url.md
to-yaml.md
trim.md
version.md
where.md

README.md

How do I get started?

Pick any command from the checklist and write a comment acknowledging 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 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.
Command usage.

Anything else?

Of course! (These are drafts) so feel free to leave feedback and suggestions in the same file.

Happy Documenting.