🧹 Clean up IDs in generated documentation

bitwizeshift · bitwizeshift · commit 9154bb3fee7d · 2023-12-28T14:01:16.000-05:00
diff --git a/tools/generate-docs/main.go b/tools/generate-docs/main.go
@@ -126,7 +126,7 @@ func (ca *CompositeAction) WriteOutputTable(w io.Writer, path string) {
 }
 
 func (ca *CompositeAction) WriteExample(w io.Writer, path, version string) {
-	id := strcase.ToKebab(strings.ReplaceAll(ca.Name, " ", "_"))
+	id := strcase.ToKebab(strings.ReplaceAll(path, "/", "_"))
 	fmt.Fprintf(w, "## Example\n")
 	fmt.Fprintf(w, "\n")
 	fmt.Fprintf(w, "Here is a very basic example of how to use the `%v` composite action\n", path)

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ func (ca *CompositeAction) WriteOutputTable(w io.Writer, path string) {`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`func (ca *CompositeAction) WriteExample(w io.Writer, path, version string) {`
`129`		`- id := strcase.ToKebab(strings.ReplaceAll(ca.Name, " ", "_"))`
	`129`	`+ id := strcase.ToKebab(strings.ReplaceAll(path, "/", "_"))`
`130`	`130`	`fmt.Fprintf(w, "## Example\n")`
`131`	`131`	`fmt.Fprintf(w, "\n")`
`132`	`132`	fmt.Fprintf(w, "Here is a very basic example of how to use the `%v` composite action\n", path)