mirror of
https://github.com/nushell/nushell.git
synced 2025-05-09 17:32:59 +00:00
b358804904
* Very rough idea * Remove colour codes * Work on command for generating docs * Quick comment * Use nested collapsible markdown * Refine documentation command * Clippy and rename docs * This layout probably seems best Also moved some code to documentation.rs to avoid making help.rs massive * Delete summaries.md * Add usage strings * Remove static annotations * get_documentation produces value Which will be used like 'help generate_docs | save "something"' The resulting yaml can be passed to a script for generating HTML/MD files in the website * Fix subcommands * DRY code * Address clippy: * Fix links * Clippy lints * Move documentation to more central location
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.