Clearly Something is Wrong!

Not only is it somewhat hard to understand the vast majority of the documentation pages because they lack examples that coherently demonstrate the usage of whatever it is you found yourself looking at in an actual context users could find themselves in (which is hard to write in the source code comments the docs are being generated from, but some pages seem to manage, so shouldn't that be added to the contribution requirements of the source code?)...

but someone did not appropriately set up the sidebar's overflow in CSS

Solution? Solution!

I would fix this myself, but I am busy at the moment with my config, a project that's gone on for years now and I would like to finish it, so you will have to wade through the css that is applied to what is pulled out of source code and smashed into the documentation site but I can help you with the specific rule you will need to add to the appropiate selector at least.

What It Will Look Like in Code

.whatever-the-selector-is-called {
// ...other random css
overflow: auto;
// or
overflow: hidden 
}

Current State's Probable CSS

its probably set to visible now, which is fine if you don't mind the bleed over I highlighted in my screenshot but personally I can't stand that.

CSS Selector Replacement Rationale

auto - adds scrollbars if needed (almost never actually needed, but in case you just have to read the link in the little sidebar space)
hidden - because its a link, this works since hovering over the link will make its content appear if not in a popup, on the bottom status bar of most browsers. This should be enough for most people

That's It

Either prevents the bleed over that cannot be read by anyone, regardless of preference.

Elv13 commented 2 years ago

I think you are using custom fonts override and you are looking at the old doc. What you see isn't what other people see.

https://awesomewm.org/apidoc/core_components/client.html

actionless commented 2 years ago

they should be scrollable in the latest apidoc, in case if it doesnt fit: 2021-11-22--1637610204_310x851_scrot

Aire-One commented 2 years ago

@Thomashighbaugh probably don't know how we are working, so here are some additional information :

The API documentation is generated from our source code at awesomewm/awesome. The documentation you can read at https://awesomewm.org/doc/api/index.html was built against the stable version when it was released (almost 4 years ago now?).

Since then, we are still working on the git version and the doc evolved a lot. The new version has fixes for your reported bug : Sections names are wrapped and module names (that can't be break) are scrollable (see Elv and Actionless screenshots). It will be published as soon as we release the next version.

I'll consider this issue resolved and close it.

awesomeWM / awesome-www