So we started to investigate the RDoc template generator, which powers the Ruby documentation, to see how it worked and what we could do with it. We f

RoRvsWild RDoc theme

submited by

Style Pass

2024-10-15 06:30:03

So we started to investigate the RDoc template generator, which powers the Ruby documentation, to see how it worked and what we could do with it. We finally made quite a few changes.

We added a fixed top bar with the project title and moved the search field there to make it always reachable. The search result benefits from more space than when they were in the sidebar.

On larger screens, we’ve hidden the navigation toggle and made the main navigation always visible. The main navigation content is now always the same on all documentation pages. It lists all the classes and pages. It’s now the documentation’s table of contents, and we could eliminate the previously separated page used for this function.

On the right side of the page, we’ve added contextual navigation that depends on the content shown. It can list metadata, such as the class ancestors, instead of just the parent. It also lists shortcuts to the various sections of the page and methods, as it is now commonly the case in documentation websites.

We wanted to improve the readability. We simplified the typography and changed the open-source fonts used. Instead of 3 families, we only use 2: Inter for text and Monaspace Neon for code. We also use fewer weights, getting rid of light versions that tend to be hard to read on screens. We used a modular scale to make titles look more harmonious. We adjusted some spacing and alignments too.