docs: improve documentation

speakeasy-api · May 19, 2023 · ff5235e · ff5235e
1 parent 730d24c
commit ff5235e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -61,6 +61,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           path: speakeasy-registry
+      - name: Configure git for private modules
+        env:
+          GITHUB_TOKEN: ${{ secrets.BOT_REPO_TOKEN }}
+        run: git config --global url."https://speakeasybot:${GITHUB_TOKEN}@github.com".insteadOf "https://github.com"
       - name: Generate speakeasy cli docs
         working-directory: speakeasy
         run: |

diff --git a/cmd/generate.go b/cmd/generate.go
@@ -146,8 +146,8 @@ func genSDKInit() {
 	genSDKCmd.Flags().StringP("installationURL", "i", "", "the language specific installation URL for installation instructions if the SDK is not published to a package manager")
 	genSDKCmd.Flags().BoolP("published", "p", false, "whether the SDK is published to a package manager or not, determines the type of installation instructions to generate")
 
-	genSDKCmd.Flags().StringP("repo", "r", "", "the repository URL for the SDK")
-	genSDKCmd.Flags().StringP("repo-subdir", "b", "", "the subdirectory of the repository where the SDK is located in the repo")
+	genSDKCmd.Flags().StringP("repo", "r", "", "the repository URL for the SDK, if the `published` flag isn't used this will be used to generate installation instructions")
+	genSDKCmd.Flags().StringP("repo-subdir", "b", "", "the subdirectory of the repository where the SDK is located in the repo, helps with documentation generation")
 
 	genSDKCmd.Flags().BoolP("output-tests", "t", false, "output internal tests for internal speakeasy use cases")
 	genSDKCmd.Flags().MarkHidden("output-tests")