cyclonedds icon indicating copy to clipboard operation
cyclonedds copied to clipboard

Formatting broken

Open Divelix opened this issue 2 years ago • 1 comments

Configuration File Reference page formatting in docs seems broken. Link: https://cyclonedds.io/docs/cyclonedds/latest/config/config_file_reference.html

Divelix avatar Nov 08 '23 12:11 Divelix

While I don't quite know what it is that you consider broken, I do agree it is not quite right, e.g.:

image

that definitely looks like it was meant to be formatted like <a href="https://cyclonedds.io/docs/cyclonedds/latest/config/config_file_reference.html#cyclonedds-domain-id">Id</a>. The code in https://github.com/eclipse-cyclonedds/cyclonedds/blob/0ed1837e31f12e53bf2c729aeb09fc431528fe43/src/tools/_confgen/generate_md.c#L173-L175 produces a proper link in Markdown, so I wonder what tool messed it up in generating HTML 🤔

image

definitely looks like it was meant to be a bulleted list of two items, that would be _confgen I assume;

image

and arguably the size of the umpteenth-level header used for the name doesn't sit nicely with the size of the body text ...

There are also some other things, but I think all of these issues are cosmetic and won't make pose a problem for anyone. So given how far I'm behind on support fixing this isn't the top priority ...

Thanks a lot for pointing it out!

eboasson avatar Nov 28 '23 07:11 eboasson