Skip to content

Revise order on Reference landing page #22558

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
v-thi opened this issue May 4, 2025 · 1 comment
Open
1 task done

Revise order on Reference landing page #22558

v-thi opened this issue May 4, 2025 · 1 comment
Assignees
Labels
area/api Relates to Docker API docs wtd-project Relates to WTD API docs project

Comments

@v-thi
Copy link

v-thi commented May 4, 2025

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

Issue created from reviewing WTD 2025 issue Review Reference landing page #22540, also is relevant to WTD 2025 issue Reorganization of Reference pages #22547

Location

https://docs.docker.com/reference/

Suggestion

To improve clarity and user experience of reference landing page, either:

  1. Revise description sentence ("This section includes the reference documentation for the Docker platform's various APIs, CLIs, drivers and specifications, and file formats.") to match existing heading/section order (File formats > CLIs > APIs), or
  2. Revert order of headings/sections to match description sentence (APIs > CLIs > File formats)

Suggest revised order to be from most to least accessed references/sections.

@v-thi v-thi 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
@v-thi v-thi changed the title Revise Order on Reference Landing Page Revise order on Reference landing page May 4, 2025
@sarahsanders-docker sarahsanders-docker self-assigned this May 9, 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