Skip to content

dhi: refresh how-to explore#24602

Open
craig-osterhout wants to merge 2 commits intodocker:mainfrom
craig-osterhout:engdocs-3222-1
Open

dhi: refresh how-to explore#24602
craig-osterhout wants to merge 2 commits intodocker:mainfrom
craig-osterhout:engdocs-3222-1

Conversation

@craig-osterhout
Copy link
Copy Markdown
Contributor

@craig-osterhout craig-osterhout commented Apr 1, 2026

Description

  • Refreshed explore based on latest GUI. Removed steps with a direct link. xref'd to previous sections to remove redundant steps.
  • Consolidated explore and compare to minimize left nav sprawl and because they're related use-cases.
  • Renamed from "explore" to "search" in order to not conflict with the about section that got renamed explore.
  • Added in CLI commands to eventually remove the bolted-on, standalone how-to cli topic.
  • Cleaned up some fluff from the compare topic that was used to make it feel more substantial when it was a standalone.

https://deploy-preview-24602--docsdocker.netlify.app/dhi/how-to/explore/

Related issues or tickets

ENGDOCS-3222

Reviews

  • Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
@craig-osterhout
Copy link
Copy Markdown
Contributor Author

/review

@netlify
Copy link
Copy Markdown

netlify bot commented Apr 1, 2026

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit d08c89d
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/69cd568d8769c1000840bf78
😎 Deploy Preview https://deploy-preview-24602--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟢 APPROVE

This PR successfully consolidates the DHI explore and compare functionality into a single, well-structured how-to guide. The changes follow Docker documentation style guidelines consistently:

Style compliance: No AI-isms, hedge words, or meta-commentary
Voice: Uses "you" and "select" appropriately
Redirects: Proper alias added for the removed /dhi/how-to/compare/ page
Front matter: All required fields present (title, description, keywords)
Markdown: Code blocks properly balanced, no formatting issues
Scope: Changes match the document's character - consolidation reduces nav sprawl while preserving content

The consolidation makes sense from a UX perspective - searching and comparing are related workflows that benefit from being on the same page.

Minor observation (not blocking): Several internal links throughout the codebase still reference /dhi/how-to/compare/ rather than pointing directly to /dhi/how-to/explore/. While the alias ensures these links work correctly, updating them to point directly to the new location would follow best practice for internal link management. This is purely a housekeeping suggestion and doesn't affect functionality.

@craig-osterhout
Copy link
Copy Markdown
Contributor Author

Minor observation (not blocking): Several internal links throughout the codebase still reference /dhi/how-to/compare/ rather than pointing directly to /dhi/how-to/explore/. While the alias ensures these links work correctly, updating them to point directly to the new location would follow best practice for internal link management. This is purely a housekeeping suggestion and doesn't affect functionality.

I didn't find any other /how-to/compare/ via search.

@craig-osterhout craig-osterhout requested a review from a team April 1, 2026 17:45
@craig-osterhout craig-osterhout added the status/review Pull requests that are ready for review label Apr 1, 2026
Copy link
Copy Markdown
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dhi status/review Pull requests that are ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants