Documentation updates

Tom Tom de Bruijn on

Keeping documentation up-to-date is always a challenge, and we were running behind. The new Elixir integration didn’t really fit in and some screenshots were outdated, to name a few issues. Recently we’ve been hard at work improving the documentation by restructuring its content, improving its navigation and adding more content.

You can take a look (and learn a thing or two) at our new and improved documentation website:

Content restructure

We’ve reworked the navigational structure of the documentation. By grouping content under some key topics, we’ve seen that’s it’s a lot easier to find the thing customers are looking for. The docs are now structured along these topics:

Splitting up content

Our old pages included a lot of information per page. We’ve split them up into bite-sized pieces, making the informations easier to digest. All our integrations now have their own page, and the Ruby gem and Elixir package have their own pages describing everything you can configure.

Tables of Content

We’ve introduced a Table of Content for topics that contain a lot of sub-headings and sub-pages, to be found on the overview pages for topics like the Ruby and Elixir configurations.

Navigation update

As more and more content is being added to our documentation, the navigation sidebar grew a little too long to be useful without endless scrolling.

With a collapsible UI we’ve made it easier to hide those parts of the docs that are unrelated to the things you’re looking for. If you’re only using Elixir and aren’t interested in the Ruby documentation, just collapse that section in the sidebar for laser focus.

Content updates

We’ve also made a lot of changes to the actual content itself. Some highlights:

We’re continuously working on improving our docs, so let us know if you are unable to find an answer, or have suggestions for improvements. Our engineers are always happy to help.

10 latest articles

Go back
Ruby magic icon

Subscribe to

Ruby Magic

Magicians never share their secrets. But we do. Sign up for our Ruby Magic email series and receive deep insights about garbage collection, memory allocation, concurrency and much more.

We'd like to set cookies, read why.