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

Compose file reference seems very hidden in help file and not to be found from starting page #12526

Open
ell1e opened this issue Feb 4, 2025 · 1 comment · May be fixed by #12559
Open

Compose file reference seems very hidden in help file and not to be found from starting page #12526

ell1e opened this issue Feb 4, 2025 · 1 comment · May be fixed by #12559

Comments

@ell1e
Copy link

ell1e commented Feb 4, 2025

Description

Perhaps I'm just too tired to navigate the docs pages, but it occurred to me perhaps beginners might be confused too:

When reading the compose starting page, you see a "compose configuration file" mentioned here. It is not clickable. This means the natural place to find out what that is, is probably "compose config" to the left:

Image

However, this seems to talk about something entirely different, but then mentions the "compose files" again but now by a different name ("compose file" rather than "compose config file") that still isn't clickable. That name also doesn't have any equivalent in the alphabetic listing to the left, where there is no F letter to be found.

Image

I happen to know what a compose file is and have used them for a while and was merely searching the reference without using a search engine, but I failed. Perhaps it's just me though, but I figured if it isn't, this could use some more links and more unified naming.

@ell1e
Copy link
Author

ell1e commented Feb 4, 2025

I found it now, I was in the "CLI reference" section and there's the "Compose file reference" that is way farther down in the navigation. However, when looking at the CLI reference this isn't quite visually obvious. I would recommend making these prominent "Compose file" mentions clickable, and to remove the different names of "Compose configuration file" that may lead users elsewhere.

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

Successfully merging a pull request may close this issue.

2 participants