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

Documentation assumes people know where to type commands. #21

Open
stockholmux opened this issue Jul 21, 2023 · 0 comments
Open

Documentation assumes people know where to type commands. #21

stockholmux opened this issue Jul 21, 2023 · 0 comments

Comments

@stockholmux
Copy link

Path to page with content (do not include domain name): /docs/getting-started/installing/

What content is incorrect? At several points in the documentation it makes a leap to assume that a user will understand that commands need to be running from a host's terminal.

Example (not exhaustive):

Verify that homebrew is already installed on the system by running the brew help command ...
Once the installation is complete, finch vm init is required once to set up the underlying system and create the virtual machines
Verify that the installation and the vm initialization have completed by running the hello-finch container image.

What should the content say or communicate?

Maybe it should say something like "...already installed on the system by running the brew help command from your favourite terminal application"

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

No branches or pull requests

1 participant