Skip to content

API Reference page too narrow #123

Open

Description

@evilhamsterman

The API reference page is very difficult to read. The container it is in is so limited that the actual documentation is cut off and you have to scroll horizontally left and right to read it, but there's not even horizontal scroll bar, so unless you have a mouse with a horizontal scroll wheel you can't even see the docs.

image

Activity

  1. AshwinSriram11 commented on Jan 10, 2025

    @AshwinSriram11
    Member

    Hi @evilhamsterman thanks for the issue, would you like to add the horizontal scroll bar?

  2. judgeaxl commented on Mar 5, 2025

    @judgeaxl

    Reformatting the docs to not need scrolling would be a better option, IMHO. For instance putting the description under each property name+type. I assume this will require modifying the source Markdown files, which would be good anyway because reading those in the GitHub file browser has the same problem, the description gets cut off.

    Hopefully one can script such a transformation.

    I suppose one could clone the repo and view it in a Markdown editor with preview on a larger screen in the meantime.

  3. audunmg commented on Aug 25, 2025

    @audunmg

    It would be nice to be able to read the docs on a portrait screen with less margins on the sides.
    To me it looks like some width is specified in pixels, making it look wrong on too large or too small screens.

    Image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions