Skip to content

Commit

Permalink
site: move user_guide
Browse files Browse the repository at this point in the history
  • Loading branch information
umarcor committed Aug 4, 2021
1 parent 9ff6b11 commit 36682dd
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 18 deletions.
26 changes: 13 additions & 13 deletions README.md
Expand Up @@ -19,17 +19,17 @@ name a few. [This list](site/content/projects_using_cobra.md) contains a more ex
* [Flags](#flags)
- [Installing](#installing)
- [Usage](#usage)
* [Using the Cobra Generator](user_guide.md#using-the-cobra-generator)
* [Using the Cobra Library](user_guide.md#using-the-cobra-library)
* [Working with Flags](user_guide.md#working-with-flags)
* [Positional and Custom Arguments](user_guide.md#positional-and-custom-arguments)
* [Example](user_guide.md#example)
* [Help Command](user_guide.md#help-command)
* [Usage Message](user_guide.md#usage-message)
* [PreRun and PostRun Hooks](user_guide.md#prerun-and-postrun-hooks)
* [Suggestions when "unknown command" happens](user_guide.md#suggestions-when-unknown-command-happens)
* [Generating documentation for your command](user_guide.md#generating-documentation-for-your-command)
* [Generating shell completions](user_guide.md#generating-shell-completions)
* [Using the Cobra Generator](site/content/user_guide.md#using-the-cobra-generator)
* [Using the Cobra Library](site/content/user_guide.md#using-the-cobra-library)
* [Working with Flags](site/content/user_guide.md#working-with-flags)
* [Positional and Custom Arguments](site/content/user_guide.md#positional-and-custom-arguments)
* [Example](site/content/user_guide.md#example)
* [Help Command](site/content/user_guide.md#help-command)
* [Usage Message](site/content/user_guide.md#usage-message)
* [PreRun and PostRun Hooks](site/content/user_guide.md#prerun-and-postrun-hooks)
* [Suggestions when "unknown command" happens](site/content/user_guide.md#suggestions-when-unknown-command-happens)
* [Generating documentation for your command](site/content/user_guide.md#generating-documentation-for-your-command)
* [Generating shell completions](site/content/user_guide.md#generating-shell-completions)
- [Contributing](CONTRIBUTING.md)
- [License](#license)

Expand Down Expand Up @@ -118,8 +118,8 @@ import "github.com/spf13/cobra"

# Usage

See [User Guide](user_guide.md).
See [User Guide](site/content/user_guide.md).

# License

Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)
13 changes: 8 additions & 5 deletions user_guide.md → site/content/user_guide.md
Expand Up @@ -29,10 +29,10 @@ func main() {

## Using the Cobra Generator

Cobra provides its own program that will create your application and add any
commands you want. It's the easiest way to incorporate Cobra into your application.
Cobra provides its own program that will create your application and add any commands you want.
It's the easiest way to incorporate Cobra into your application.

[Here](https://github.com/spf13/cobra/blob/master/cobra/README.md) you can find more information about it.
[Here](CLI.md) you can find more information about it.

## Using the Cobra Library

Expand Down Expand Up @@ -630,8 +630,11 @@ Run 'kubectl help' for usage.

## Generating documentation for your command

Cobra can generate documentation based on subcommands, flags, etc. Read more about it in the [docs generation documentation](doc/README.md).
Cobra can generate documentation based on subcommands, flags, etc.
Read more about it in the [docs generation documentation](docgen/_index.md).

## Generating shell completions

Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell. If you add more information to your commands, these completions can be amazingly powerful and flexible. Read more about it in [Shell Completions](shell_completions.md).
Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell.
If you add more information to your commands, these completions can be amazingly powerful and flexible.
Read more about it in [Shell Completions](completions/_index.md).

0 comments on commit 36682dd

Please sign in to comment.