Skip to content

Commit 424fb2c

Browse files
committed
site: move user_guide
1 parent b247641 commit 424fb2c

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ go install github.com/spf13/cobra-cli@latest
104104

105105
For complete details on using the Cobra-CLI generator, please read [The Cobra Generator README](https://github.com/spf13/cobra-cli/blob/master/README.md)
106106

107-
For complete details on using the Cobra library, please read the [The Cobra User Guide](user_guide.md).
107+
For complete details on using the Cobra library, please read the [The Cobra User Guide](site/content/user_guide.md).
108108

109109
# License
110110

111-
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
111+
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)

user_guide.md renamed to site/content/user_guide.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ func main() {
2929

3030
## Using the Cobra Generator
3131

32-
Cobra-CLI is its own program that will create your application and add any
33-
commands you want. It's the easiest way to incorporate Cobra into your application.
32+
Cobra-CLI is its own program that will create your application and add any commands you want.
33+
It's the easiest way to incorporate Cobra into your application.
3434

35-
For complete details on using the Cobra generator, please refer to [The Cobra-CLI Generator README](https://github.com/spf13/cobra-cli/blob/master/README.md)
35+
For complete details on using the Cobra generator, please read [The Cobra-CLI Generator README](https://github.com/spf13/cobra-cli/blob/master/README.md).
3636

3737
## Using the Cobra Library
3838

@@ -631,8 +631,11 @@ Run 'kubectl help' for usage.
631631

632632
## Generating documentation for your command
633633

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

636637
## Generating shell completions
637638

638-
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).
639+
Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell.
640+
If you add more information to your commands, these completions can be amazingly powerful and flexible.
641+
Read more about it in [Shell Completions](completions/_index.md).

0 commit comments

Comments
 (0)