Skip to content

Commit 229590e

Browse files
committed
site: move user_guide
1 parent 7581064 commit 229590e

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

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

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

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

110110
# License
111111

112-
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
112+
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: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ 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

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

@@ -715,12 +715,17 @@ Run 'kubectl help' for usage.
715715

716716
## Generating documentation for your command
717717

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

720721
## Generating shell completions
721722

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

724727
## Providing Active Help
725728

726-
Cobra makes use of the shell-completion system to define a framework allowing you to provide Active Help to your users. Active Help are messages (hints, warnings, etc) printed as the program is being used. Read more about it in [Active Help](active_help.md).
729+
Cobra makes use of the shell-completion system to define a framework allowing you to provide Active Help to your users.
730+
Active Help are messages (hints, warnings, etc) printed as the program is being used.
731+
Read more about it in [Active Help](active_help.md).

0 commit comments

Comments
 (0)