gazebosim / docs

High-level Gazebo documentation that gets published to https://gazebosim.org/docs/
https://gazebosim.org/docs
44 stars 81 forks source link

Left menu on Docs page does not display text as specified #359

Open Bi0T1N opened 1 year ago

Bi0T1N commented 1 year ago

Description

Steps to reproduce

  1. Go to https://gazebosim.org/docs
  2. Notice that the left menu shows "Ros/gazebo Installation"
  3. Compare with what is written in index.yaml
Bi0T1N commented 1 year ago

It's not just the single page listed above, it's wrong for all entries with more than one word. To give some more examples:

It uses its own mechanism for capitalization of the output instead of respecting what is defined in the index.yaml file.

Bi0T1N commented 1 year ago

I'm not an expert in Golang but the casing might come from the strings.Title() function. It's not used directly in gazebosim-web-backend or gz-go but within the go-gorm dependency. At least the following examples show the same phenomenon that can be observed at the moment:

package main

import (
    "fmt"
    "strings"
)

func main() {
    fmt.Println(strings.Title(strings.ToLower("Migration from Ignition"))) // Migration From Ignition
    fmt.Println(strings.Title(strings.ToLower("Spawn URDF"))) // Spawn Urdf
    fmt.Println(strings.Title(strings.ToLower("Understanding the GUI"))) // Understanding The Gui
}