Skip to content

Commit 773517d

Browse files
committed
Update links to Cobra documentation
The Cobra documentation content was recently moved to a new location in the spf13/cobra repository. The move broke the links to that content in the '"Deploy Website" workflow (Cobra, versioned, MkDocs, Poetry)' template documentation.
1 parent 2ea2f98 commit 773517d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Generate a command line reference for projects using [the Cobra Go module](https://cobra.dev/) and deploy a versioned [MkDocs](https://www.mkdocs.org/)-based static website to [GitHub Pages](https://pages.github.com/).
44

55
This uses Cobra's built-in Markdown documentation generation capability:<br/>
6-
https://github.com/spf13/cobra/blob/master/doc/md_docs.md
6+
https://github.com/spf13/cobra/blob/main/site/content/docgen/md.md
77

88
Documentation content will sometimes apply only to a specific version of the project. For this reason, it's important for the reader to be able to access the documentation for the specific version of the project they are using.
99
The system provides a easy access to a website version for the documentation content at:
@@ -51,7 +51,7 @@ If there are any additional documentation generation tasks, add them to the `doc
5151
- [`go.mod`](assets/cobra/docsgen/go.mod) - replace `MODULE_NAME` with the project's module name.
5252
- [`main.go`](assets/cobra/docsgen/main.go)
5353
- replace `CLI_PACKAGE_NAME` with the project's Cobra CLI package name
54-
- replace `cli.NewCommand()` with the project's Cobra CLI package function for [command root](https://github.com/spf13/cobra/blob/master/user_guide.md#create-rootcmd) generation
54+
- replace `cli.NewCommand()` with the project's Cobra CLI package function for [command root](https://github.com/spf13/cobra/blob/main/site/content/user_guide.md#create-rootcmd) generation
5555

5656
Run the following command from the `docsgen/` folder:
5757

0 commit comments

Comments
 (0)