chore: Remove outdated local CLI documentation (#1272)

Reference:
https://linear.app/speakeasy/issue/GEN-1020/bug-generating-broken-links-in-the-cli-reference
Reference:
https://www.speakeasy.com/docs/speakeasy-reference/cli/getting-started

This change removes the outdated local CLI documentation in the `docs/`
directory and updates the documentation generation script to remove that
now extraneous logic. This also removes the unused Docusaurus
positioning. The CLI documentation will remain and still be updated on
the Speakeasy website.

.github/workflows/documentation.yml

@@ -40,14 +40,10 @@ jobs:
         uses: actions/setup-go@f111f3307d8850f501ac008e886eec1fd1932a34 # v5.3.0
         with:
           go-version-file: "speakeasy/go.mod"
-      - name: Generate speakeasy cli docs
-        working-directory: speakeasy
-        run: |
-          go run cmd/docs/main.go
       - name: Generate speakeasy-registry doc-site docs
         working-directory: speakeasy
         run: |
-          go run cmd/docs/main.go -out-dir ../speakeasy-registry/web/packages/marketing-site/src/pages/docs/speakeasy-reference/cli -doc-site
+          go run cmd/docs/main.go -out-dir ../speakeasy-registry/web/packages/marketing-site/src/pages/docs/speakeasy-reference/cli
       - name: Create PR against speakeasy-registry
         uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
         with:

.gitignore

@@ -1,4 +1,5 @@
 dist/
+/docs/
 bin/
 .idea/
 *.iml

cmd/docs/main.go

@@ -2,13 +2,11 @@ package main
 
 import (
 	"flag"
-	"fmt"
 	"log"
 	"os"
 	"path/filepath"
 	"regexp"
 	"slices"
-	"strings"
 
 	"github.com/speakeasy-api/speakeasy/cmd"
 	"github.com/speakeasy-api/speakeasy/internal/docs"
@@ -18,7 +16,6 @@ var linkRegex = regexp.MustCompile(`\((.*?\.md)\)`)
 
 func main() {
 	outDir := flag.String("out-dir", "./docs", "The directory to output the docs to")
-	docSite := flag.Bool("doc-site", false, "Whether to generate docs for the doc site")
 	flag.Parse()
 
 	cmd.Init("", "")
@@ -36,34 +33,7 @@ func main() {
 		log.Fatal(err)
 	}
 
-	if err := docs.GenerateDocs(root, *outDir, *docSite); err != nil {
-		log.Fatal(err)
-	}
-
-	if *docSite {
-		return
-	}
-
-	readmeData, err := os.ReadFile("./README.md")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	readme, _, _ := strings.Cut(string(readmeData), "## CLI")
-
-	speakeasyData, err := os.ReadFile("./docs/README.md")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	speakeasyDoc := linkRegex.ReplaceAllStringFunc(string(speakeasyData), func(match string) string {
-		return fmt.Sprintf("(docs/%s)", strings.Trim(match, "()"))
-	})
-
-	speakeasyDoc = strings.ReplaceAll(speakeasyDoc, "## ", "### ")
-	speakeasyDoc = strings.Replace(speakeasyDoc, "# speakeasy", "## CLI", 1)
-
-	if err := os.WriteFile("./README.md", []byte(fmt.Sprintf("%s%s", readme, speakeasyDoc)), 0o644); err != nil {
+	if err := docs.GenerateDocs(root, *outDir); err != nil {
 		log.Fatal(err)
 	}
 }