Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api docs issues #1234

Open
katacek opened this issue Oct 7, 2024 · 1 comment
Open

Api docs issues #1234

katacek opened this issue Oct 7, 2024 · 1 comment
Labels
bug Something isn't working. medium priority Medium priority issues to be done in a couple of sprints. t-docs Issues owned by technical writing team. t-tooling Issues with this label are in the ownership of the tooling team.

Comments

@katacek
Copy link
Member

katacek commented Oct 7, 2024

Reported on slack along with more discussion

  1. When following a link to API docs, it will scroll to the bottom of the page (as in the provided video)
  2. Expandable objects inside the response schemas are inside white blocks (e.g. userData from https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_get see provided image)
  3. The link should have separated section and subsection by some delimiter (e.g. https://docs.apify.com/api/v2#tag/Request-queuesQueue/operation/requestQueue_request_get: /Request-queuesQueue/ -> /Request-queues/Queue/)

// Bottom scrolling when fllowing link
https://github.com/user-attachments/assets/0da21d2d-72bb-41d5-b792-77bd852ecd80

// White blocks for expandable items
image (37)

@katacek katacek added bug Something isn't working. medium priority Medium priority issues to be done in a couple of sprints. labels Oct 7, 2024
@jancurn
Copy link
Member

jancurn commented Oct 7, 2024

cc @netmilk

@fnesveda fnesveda added t-tooling Issues with this label are in the ownership of the tooling team. t-docs Issues owned by technical writing team. labels Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working. medium priority Medium priority issues to be done in a couple of sprints. t-docs Issues owned by technical writing team. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

No branches or pull requests

3 participants