Skip to content

Documentation assumes people know where to type commands. #21

Description

@stockholmux

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"

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions