Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-11-14 17:07:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
nushell/docs/commands
History
Shaurya Shubham 539e232f3c Added docs for most of the to-sth commands 
Partial fix of issue #711
Docs for the following commands were added -
to-csv
to-json
to-toml
to-tsv
to-url
to-yaml

Docs for to-db , to-bson , to-sqlite have not been added as I don't recognize and understand those formats.
2019-10-03 19:07:48 +05:30
..
cd.md Improve cd docs 2019-10-01 19:23:10 +05:30
date.md Fix typo in date.cmd 2019-10-01 11:21:56 -03:00
echo.md Add echo command documentation 2019-10-01 06:14:56 -04:00
exit.md Improved exit command docs 2019-10-02 06:55:30 +05:30
first.md add documentation file for first command 2019-10-02 15:49:44 -04:00
help.md Add document for help 2019-10-01 23:20:58 +08:00
README.md More command documentation instructions. 2019-09-25 11:35:58 -05:00
reverse.md Create docs for reverse command 2019-10-02 15:03:28 +05:30
shells.md Created docs for shells command 2019-10-02 13:37:43 +05:30
to-csv.md Added docs for most of the to-sth commands 2019-10-03 19:07:48 +05:30
to-json.md Added docs for most of the to-sth commands 2019-10-03 19:07:48 +05:30
to-toml.md Added docs for most of the to-sth commands 2019-10-03 19:07:48 +05:30
to-tsv.md Added docs for most of the to-sth commands 2019-10-03 19:07:48 +05:30
to-url.md Added docs for most of the to-sth commands 2019-10-03 19:07:48 +05:30
to-yaml.md Added docs for most of the to-sth commands 2019-10-03 19:07:48 +05:30
version.md Create docs for version command 2019-10-02 15:47:56 +05:30
where.md Add documentation for where command 2019-10-02 22:49:05 -03:00

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.