Merge pull request #28 from Shresht7:refactor-docs

Refactors the docs and docs-generator

.github/workflows/go.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v5
       with:
-        go-version: 1.21
+        go-version: 1.22
 
     - name: Build
       run: go build -v ./...

.vscode/tasks.json

@@ -15,7 +15,7 @@
         {
             "label": "doc",
             "type": "shell",
-            "command": "go run docs/generator/main.go docs/generator/toTemplateData.go docs/generator/generateREADME.go docs/generator/generateDocumentation.go",
+            "command": "go run ./docs/generator/...",
             "group": {
                 "kind": "build",
                 "isDefault": true

docs/generator/generateDocumentation.go

@@ -8,7 +8,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// Generates the documentation for the given cobra command. If recurse is true,
+// Generates the documentation for the given cobra command in the given directory. If recurse is `true`,
 // it will recurse through the subcommands and generate documentation for them as well
 func generateDocumentation(cmd *cobra.Command, dir string, recurse bool) error {
 
@@ -22,10 +22,11 @@ func generateDocumentation(cmd *cobra.Command, dir string, recurse bool) error {
 
 	// Create and parse the template definitions
 	tmpl := template.Must(template.ParseFiles(
-		"docs/templates/command.md",
-		"docs/templates/_back-to-top.md",
+		"docs/generator/templates/command.md",
+		"docs/generator/templates/_back-to-top.md",
 	))
 
+	// Execute and write the template to the file
 	err = tmpl.Execute(w, toTemplateData(cmd))
 	if err != nil {
 		return err
@@ -53,10 +54,11 @@ func generateDocumentation(cmd *cobra.Command, dir string, recurse bool) error {
 
 	// Create and parse the template definitions
 	tmpl = template.Must(template.ParseFiles(
-		"docs/templates/index.md",
-		"docs/templates/_back-to-top.md",
+		"docs/generator/templates/index.md",
+		"docs/generator/templates/_back-to-top.md",
 	))
 
+	// Execute and write the template to the README file
 	err = tmpl.Execute(i, toTemplateData(cmd))
 	if err != nil {
 		return err

docs/generator/generateREADME.go

@@ -6,12 +6,9 @@ import (
 	"os"
 
 	"github.com/spf13/cobra"
-
-	"github.com/Shresht7/goutils/slice"
 )
 
 // Generates the main README.md file for the project.
-// It uses templates from the docs/templates directory.
 func generateREADME(cmd *cobra.Command) error {
 
 	// Create the README.md file
@@ -23,14 +20,13 @@ func generateREADME(cmd *cobra.Command) error {
 
 	// Create and parse the template definitions
 	tmpl := template.Must(template.ParseFiles(
-		"docs/templates/README.md",
-		"docs/templates/_back-to-top.md",
-		"docs/templates/_command-readme.md",
+		"docs/generator/templates/README.md",
+		"docs/generator/templates/_back-to-top.md",
+		"docs/generator/templates/_command-readme.md",
 	))
 
-	err = tmpl.Execute(w, slice.Map(cmd.Commands(), func(cmd *cobra.Command, idx int) map[string]any {
-		return toTemplateData(cmd)
-	}))
+	// Execute the template and write the README.md file
+	err = tmpl.Execute(w, toTemplateData(cmd))
 	if err != nil {
 		return err
 	}

docs/generator/main.go

@@ -6,11 +6,10 @@ import (
 	"github.com/Shresht7/gh-license/cmd"
 )
 
-// Generate generates the documentation for this project
+// Generates documentation for this project
 func main() {
 
-	// Generate the documentation for the root command and all subcommands
-	// The documentation will be generated in the docs directory
+	// Generate the documentation for the root command and all subcommands in the "docs" folder
 	err := generateDocumentation(cmd.RootCmd, "docs", true)
 	if err != nil {
 		log.Fatal(err)

docs/templates/README.md → docs/generator/templates/README.md

@@ -40,7 +40,7 @@ gh license create mit
 
 ## ⌨️ Commands
 
-{{ range . }}
+{{ range .Commands }}
 {{- template "Command" . -}}
 {{ end }}
 

docs/generator/toTemplateData.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/Shresht7/Scribe/markdown"
 	"github.com/Shresht7/goutils/slice"
-	str "github.com/Shresht7/goutils/strings"
 )
 
 // HELPER FUNCTIONS
@@ -27,7 +26,7 @@ func toTemplateData(cmd *cobra.Command) map[string]any {
 
 		"Aliases": strings.Join(
 			slice.Map(cmd.Aliases, func(x string, i int) string {
-				return str.Wrap("`", x)
+				return markdown.Code(x)
 			}),
 			", ",
 		),
@@ -68,7 +67,7 @@ func toTemplateData(cmd *cobra.Command) map[string]any {
 				// Append the row
 				rows = append(rows, []string{
 					"`--" + flag.Name + ", -" + flag.Shorthand + "`",
-					str.Wrap("`", flag.Value.Type()),
+					markdown.Code(flag.Value.Type()),
 					flag.Usage,
 					flag.DefValue,
 				})

go.mod

@@ -1,6 +1,6 @@
 module github.com/Shresht7/gh-license
 
-go 1.21
+go 1.22
 
 require (
 	github.com/Shresht7/Scribe v0.0.0-20230331052318-69ae28065919