Skip to content

Command reference should note if a command is not available on all platforms #3436

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
jandubois opened this issue Apr 16, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jandubois
Copy link
Member

#3425 removed the sudoers command from Linux and Windows.

The start-at-login command was never available on Windows.

The docs should note these restrictions:

Also, since netlify runs the build step on Linux, I would have expected that the sudoers reference page would be removed now. I don't understand why it claims (in GitHub actions) there were no changes. Maybe it does not detect when a page is being deleted?

When I run make docsy locally on Linux, then the sudoers page is no longer generated.

Which means with the current setup we will not have documentation for commands that are not included on Linux. So it might be better to always add them, and have them output The foo is not supported on this platform than just removing them.

I think that error is less confusing to the user than

FATA[0000] unknown command "foo" for "limactl"

when the online docs claim that the command exists.

@AkihiroSuda AkihiroSuda added the documentation Improvements or additions to documentation label Apr 17, 2025
@AkihiroSuda
Copy link
Member

So it might be better to always add them, and have them output The foo is not supported on this platform than just removing them.

👍

@alexandear
Copy link
Member

Also, since netlify runs the build step on Linux, I would have expected that the sudoers reference page would be removed now.

It's removed for me:

Image

In the short term, we can revert #3425

In the long term, it might be better to update the docs to display slightly different information depending on the platform. The pkg.go.dev already does this:

Image

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

No branches or pull requests

3 participants