Skip to content

Review Reference landing page #22540

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

Review Reference landing page #22540

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

Comments

@sarahsanders-docker
Copy link
Collaborator

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

Task: Look at the Reference landing page. Identify general improvements for information architecture, clarity, etc.

Location

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

Suggestion

No response

@sarahsanders-docker sarahsanders-docker added the wtd-project Relates to WTD API docs project label May 1, 2025
@sarahsanders-docker sarahsanders-docker changed the title Review Reference landing page Review reference landing page May 1, 2025
@sarahsanders-docker sarahsanders-docker changed the title Review reference landing page Review Reference landing page May 1, 2025
@v-thi
Copy link

v-thi commented May 4, 2025

(from WTD 2025 Writing Day)

Suggestion to improve clarity on reference page through parallel structure, with description sentence and order of the 3 headings/sections.

Either revise description sentence to match existing heading/section order (File formats, CLIs, APIs) or revert order of headings/sections to match description sentence (APIs, CLIs, File formats).

@sarahsanders-docker sarahsanders-docker moved this from Todo to In Progress in wtd-project May 7, 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: In Progress
Development

No branches or pull requests

2 participants