Skip to content

Section Separation and Ordering for Engine API #22583

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

Open
1 task done
RoughlyHewn opened this issue May 4, 2025 · 0 comments
Open
1 task done

Section Separation and Ordering for Engine API #22583

RoughlyHewn opened this issue May 4, 2025 · 0 comments
Assignees
Labels
area/api Relates to Docker API docs wtd-project Relates to WTD API docs project

Comments

@RoughlyHewn
Copy link

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

The endpoint section is not separated from the non-endpoint information. There is no clear ordering for the endpoints.

Location

https://docs.docker.com/reference/api/engine/version/v1.49/

Suggestion

Create a "Getting Started" or "Overview" heading to contain the Errors, Versioning, and Authentication sections. Below that, create an "Endpoint" heading and consider ordering the endpoints in alphabetical order.

@RoughlyHewn RoughlyHewn added the status/triage Needs triage label May 4, 2025
@sarahsanders-docker sarahsanders-docker added wtd-project Relates to WTD API docs project and removed status/triage Needs triage labels May 4, 2025
@sarahsanders-docker sarahsanders-docker self-assigned this May 4, 2025
@sarahsanders-docker sarahsanders-docker added the area/api Relates to Docker API docs label May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Relates to Docker API docs wtd-project Relates to WTD API docs project
Projects
Status: No status
Development

No branches or pull requests

2 participants