New API Reference web doc feedback

Now gives one a markdown version of the docs!

Bonus: it’s off the platform site, so it doesn’t take 15 seconds of account login churning to see the docs.

https://developers.openai.com/api/docs

Issues:

Interior overflow scrollbars completely ungrabbable in Firefox.

  • The only way to navigate in responses → streaming events with a pointer device seems to be to hover (selection not pinned) and to mouse-wheel. The scroll bar of this container is non-functional; the page’s outer scroll is nonexistent.

Very slow on resizing

Width resizing: many seconds of 100% CPU in multiple steps of different listeners being activated. The result transitions between steps between truncated right-edge and extra padding right edge.

Example: after all that, the width finally lands on “broken” in Chromium:

Unpredictable collapse of sidebar

Pick a comfortable width. One pixel more and the document kills the sidebar. Ditch the @media - let the reader decide their responsiveness.

No links into the documentation.

To give a link to a specific event or parameter? Impossible. As close as you will get to sharing a particular streaming event is this plaintext soup path:

https://developers.openai.com/api/reference/resources/responses#(resource)%20responses%20%3E%20(model)%20response_stream_event%20%3E%20(schema)

No videos will be offered to first-level support.

1 Like