search

quarkiverse / antora-ui-quarkiverse

Antora UI bundle for the Quarkiverse website
Mozilla Public License 2.0
1 stars 3 forks source link

Figure out how to better present config options #56

Open ppalaga opened 11 months ago

ppalaga commented 11 months ago

In Quarkus CXF we often have longer docs for the individual config options, sometimes explaining various possible values, sometimes giving code examples. I guess there is some potential to find a better way how to present it.

This is how it currently looks like: https://docs.quarkiverse.io/quarkus-cxf/dev/reference/extensions/quarkus-cxf.html image

I am aware that the fix would not go to antora-ui-quarkiverse, but still, I believe this the best place to discuss the direction.

ppalaga commented 11 months ago

An idea how this could be solved: Type and default would not be in a separate column

A. The'd either be on the same line with the property name,

quarkus.cxf.codegen.wsdl2java.includes · list of string · no default, required

or

B. Be placed under it on separate lines

quarkus.cxf.codegen.wsdl2java.includes

  • list of string
  • no default, required

The property description could then stretch through the whole width of the page.

ppalaga commented 10 months ago

Do you happen to have any opinion on this @holly-cummins?

Another related question is how could we render the @since information for those options where it is available in the associated Java member. It is currently ignored altogether. moved to https://github.com/quarkiverse/antora-ui-quarkiverse/issues/64

ppalaga commented 8 months ago

Any opinion on this @holly-cummins?

maxandersen commented 8 months ago

a simple fix for this one is having the columns be top aligned.

so it at least the key, type and value visually is on same line.

About the large chunk of docs (which is not the general case) I'm not sure we can do much.

Not sure when your screenshot is from but on my screen the whitespace issue is not as profound:

image