docs: beautify routes and reference generation

algorandfoundation · Jan 6, 2025 · 8d2d32c · 8d2d32c
1 parent 295466c
commit 8d2d32c
Show file tree

Hide file tree

Showing 15 changed files with 33 additions and 33 deletions.
diff --git a/docs/src/content/docs/reference/algorun.md b/docs/src/content/docs/reference/algorun.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun"
-slug: "algorun"
+slug: "reference/algorun"
 ---
 ## Synopsis                                             
                                                                                                     
@@ -26,14 +26,14 @@ algorun [flags]
 
 ### SEE ALSO
 
-* [algorun bootstrap](/reference/algorun_bootstrap)	 - Initialize a fresh node
-* [algorun catchup](/reference/algorun_catchup)	 - Manage Fast-Catchup for your node
-* [algorun configure](/reference/algorun_configure)	 - Change settings on the system (WIP)
-* [algorun debug](/reference/algorun_debug)	 - Display debugging information
-* [algorun install](/reference/algorun_install)	 - Install the node daemon
-* [algorun start](/reference/algorun_start)	 - Start the node daemon
-* [algorun stop](/reference/algorun_stop)	 - Stop the node daemon
-* [algorun uninstall](/reference/algorun_uninstall)	 - Uninstall the node daemon
-* [algorun upgrade](/reference/algorun_upgrade)	 - Upgrade the node daemon
+* [algorun bootstrap](/reference/algorun/bootstrap)	 - Initialize a fresh node
+* [algorun catchup](/reference/algorun/catchup)	 - Manage Fast-Catchup for your node
+* [algorun configure](/reference/algorun/configure)	 - Change settings on the system (WIP)
+* [algorun debug](/reference/algorun/debug)	 - Display debugging information
+* [algorun install](/reference/algorun/install)	 - Install the node daemon
+* [algorun start](/reference/algorun/start)	 - Start the node daemon
+* [algorun stop](/reference/algorun/stop)	 - Stop the node daemon
+* [algorun uninstall](/reference/algorun/uninstall)	 - Uninstall the node daemon
+* [algorun upgrade](/reference/algorun/upgrade)	 - Upgrade the node daemon
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_bootstrap.md b/docs/src/content/docs/reference/algorun_bootstrap.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun bootstrap"
-slug: "algorun_bootstrap"
+slug: "reference/algorun/bootstrap"
 ---
 ## Synopsis                                                  
                                                                                                          

diff --git a/docs/src/content/docs/reference/algorun_catchup.md b/docs/src/content/docs/reference/algorun_catchup.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun catchup"
-slug: "algorun_catchup"
+slug: "reference/algorun/catchup"
 ---
 ## Synopsis                                          
                                                                                                  
@@ -27,8 +27,8 @@ algorun catchup [flags]
 ### SEE ALSO
 
 * [algorun](/reference/algorun)	 - Manage Algorand nodes from the command line
-* [algorun catchup debug](/reference/algorun_catchup_debug)	 - Display debug information for Fast-Catchup.
-* [algorun catchup start](/reference/algorun_catchup_start)	 - Get the latest catchpoint and start catching up.
-* [algorun catchup stop](/reference/algorun_catchup_stop)	 - Stop a fast catchup
+* [algorun catchup debug](/reference/algorun/catchup/debug)	 - Display debug information for Fast-Catchup.
+* [algorun catchup start](/reference/algorun/catchup/start)	 - Get the latest catchpoint and start catching up.
+* [algorun catchup stop](/reference/algorun/catchup/stop)	 - Stop a fast catchup
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_catchup_debug.md b/docs/src/content/docs/reference/algorun_catchup_debug.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun catchup debug"
-slug: "algorun_catchup_debug"
+slug: "reference/algorun/catchup/debug"
 ---
 ## Synopsis      
                                                              
@@ -25,6 +25,6 @@ algorun catchup debug [flags]
 
 ### SEE ALSO
 
-* [algorun catchup](/reference/algorun_catchup)	 - Manage Fast-Catchup for your node
+* [algorun catchup](/reference/algorun/catchup)	 - Manage Fast-Catchup for your node
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_catchup_start.md b/docs/src/content/docs/reference/algorun_catchup_start.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun catchup start"
-slug: "algorun_catchup_start"
+slug: "reference/algorun/catchup/start"
 ---
 ## Synopsis                                          
                                                                                                  
@@ -26,6 +26,6 @@ algorun catchup start [flags]
 
 ### SEE ALSO
 
-* [algorun catchup](/reference/algorun_catchup)	 - Manage Fast-Catchup for your node
+* [algorun catchup](/reference/algorun/catchup)	 - Manage Fast-Catchup for your node
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_catchup_stop.md b/docs/src/content/docs/reference/algorun_catchup_stop.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun catchup stop"
-slug: "algorun_catchup_stop"
+slug: "reference/algorun/catchup/stop"
 ---
 ## Synopsis                            
                                                                                    
@@ -25,6 +25,6 @@ algorun catchup stop [flags]
 
 ### SEE ALSO
 
-* [algorun catchup](/reference/algorun_catchup)	 - Manage Fast-Catchup for your node
+* [algorun catchup](/reference/algorun/catchup)	 - Manage Fast-Catchup for your node
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_configure.md b/docs/src/content/docs/reference/algorun_configure.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun configure"
-slug: "algorun_configure"
+slug: "reference/algorun/configure"
 ---
 ## Synopsis                             
                                                                                     
@@ -21,6 +21,6 @@ Note: This is still a work in progress. Expect bugs and rough edges.
 ### SEE ALSO
 
 * [algorun](/reference/algorun)	 - Manage Algorand nodes from the command line
-* [algorun configure service](/reference/algorun_configure_service)	 - Install service files for the Algorand daemon.
+* [algorun configure service](/reference/algorun/configure/service)	 - Install service files for the Algorand daemon.
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_configure_service.md b/docs/src/content/docs/reference/algorun_configure_service.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun configure service"
-slug: "algorun_configure_service"
+slug: "reference/algorun/configure/service"
 ---
 ## Synopsis                 
                                                                         
@@ -24,6 +24,6 @@ algorun configure service [flags]
 
 ### SEE ALSO
 
-* [algorun configure](/reference/algorun_configure)	 - Change settings on the system (WIP)
+* [algorun configure](/reference/algorun/configure)	 - Change settings on the system (WIP)
 
 ###### Auto generated by spf13/cobra on 6-Jan-2025
diff --git a/docs/src/content/docs/reference/algorun_debug.md b/docs/src/content/docs/reference/algorun_debug.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun debug"
-slug: "algorun_debug"
+slug: "reference/algorun/debug"
 ---
 ## Synopsis                               
                                                                                       

diff --git a/docs/src/content/docs/reference/algorun_install.md b/docs/src/content/docs/reference/algorun_install.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun install"
-slug: "algorun_install"
+slug: "reference/algorun/install"
 ---
 ## Synopsis                                    
                                                                                            

diff --git a/docs/src/content/docs/reference/algorun_start.md b/docs/src/content/docs/reference/algorun_start.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun start"
-slug: "algorun_start"
+slug: "reference/algorun/start"
 ---
 ## Synopsis                                                                        
                                                                                                                                

diff --git a/docs/src/content/docs/reference/algorun_stop.md b/docs/src/content/docs/reference/algorun_stop.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun stop"
-slug: "algorun_stop"
+slug: "reference/algorun/stop"
 ---
 ## Synopsis                                           
                                                                                                   

diff --git a/docs/src/content/docs/reference/algorun_uninstall.md b/docs/src/content/docs/reference/algorun_uninstall.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun uninstall"
-slug: "algorun_uninstall"
+slug: "reference/algorun/uninstall"
 ---
 ## Synopsis                                  
                                                                                          

diff --git a/docs/src/content/docs/reference/algorun_upgrade.md b/docs/src/content/docs/reference/algorun_upgrade.md
@@ -1,6 +1,6 @@
 ---
 title: "algorun upgrade"
-slug: "algorun_upgrade"
+slug: "reference/algorun/upgrade"
 ---
 ## Synopsis            
                                                                    

diff --git a/scripts/documentation.go b/scripts/documentation.go
@@ -167,11 +167,11 @@ func generateStarlightMarkdown() error {
 		name := filepath.Base(filename)
 		base := strings.TrimSuffix(name, path.Ext(name))
 
-		return fmt.Sprintf(fmTemplate, strings.Replace(base, "_", " ", -1), base)
+		return fmt.Sprintf(fmTemplate, strings.Replace(base, "_", " ", -1), fmt.Sprintf("reference/%s", strings.Replace(base, "_", "/", -1)))
 	}
 	linkHandler := func(name string) string {
 		base := strings.TrimSuffix(name, path.Ext(name))
-		return "/reference/" + strings.ToLower(base)
+		return "/reference/" + strings.Replace(base, "_", "/", -1)
 	}
 	return doc.GenMarkdownTreeCustom(cmd.RootCmd, "./docs/src/content/docs/reference", filePrepender, linkHandler)
 }