runfinch / finch-website Goto Github PK

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

What content is incorrect?

It currently says:

To get started with Finch on macOS, the development machine must meet the following pre-requisites.

macOS versions:
13 Ventura
12 Monterey
11 Big Sur

What should the content say or communicate?

This makes it sound like only 11/12/13 are supported. Additionally, runfinch/finch says "macOS catalina (10.15) or higher, newer versions are tested on a best-effort basis"

So does it require MacOS 11 or 15? It's unclear.

Path to page with content (do not include domain name): n/a

What content is incorrect?

I'm noticing some inconsistencies in the content. It's unclear what the guidelines are for writing.

What should the content say or communicate?

The site should have a style guide to make writing concretely consistent.

Path to page with content (do not include domain name):

./docs/getting-started/installing/

What content is incorrect?

brew install --cask finch can just be brew install finch

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"

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

What content is incorrect?

Prerequisites
To get started with Finch on macOS, the development machine must meet the following pre-requisites.

What should the content say or communicate?

Is it hyphenated or not?

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

Should we have a disclaimer somewhere saying that you do not have to write finch commands with \? It could be obvious, but I'm thinking about new/novice users. WDYT?

Path to page with content (do not include domain name):
docs/configuration-reference/

What content is incorrect?
Current site lists defaults and explanations.

What should the content say or communicate?
Content could provide advantages/disadvantages (why) of running each vz mode.

Path to page with content (do not include domain name): runfinch/finch-website/blob/main/README.md

What content is incorrect?

The readme doesn't include directions to use mkdocs locally.

What should the content say or communicate?

The readme should include directions to use mkdocs locally.

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

What content is incorrect? "Once the Application Package has been download,"

What should the content say or communicate? "Once the Application Package has been downloaded"

Path to page with content (do not include domain name): /architecture/

What content is incorrect?

I think there should be a space between 'apache' and '2.0', it's written currently as Apache2.0

What should the content say or communicate?

Apache 2.0

Path to page with content (do not include domain name): /

What content is incorrect?
Finch aims to help promote innovate upstream container projects

What should the content say or communicate?
help promote innovate doesn't grammatically parse. Maybe 'and' between 'promote' and 'innovate'

Path to the page with the problem (do not include domain name): /

Describe the problem:

The link is correct to nerdctl and buildkit on the home page

Screenshot, if possible

Looks fine - link is rendered wrong in the href

Describe how the site should look?

Path to page with content (do not include domain name): /architecture/

What content is incorrect?

containerdis an industry-standard

What should the content say or communicate?

containerd is an industry-standard

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

What content is incorrect? "In this short you learned how to install Finch on to your workstation and start the virtual machine."

What should the content say or communicate? "In this short guide you learned how to install Finch on to your workstation and start the virtual machine.

In #30 we switched from the latest Finch release to the main branch in the "sync" python script. This was done so we could pick up the auto generated Finch CLI docs that currently exist in main. Once we cut the next Finch release we should change the CI to can go back to pulling from a Finch release.

Path to page with content (do not include domain name): /

What content is incorrect?

Second para current reads:

Today Finch is available for developers using macOS...

What should the content say or communicate?

Today, Finch is available for developers using macOS...

Path to page with content (do not include domain name):
docs/configuration-reference/

What content is incorrect?
"Finch has a configuration file stored at ~/.finch/finch.yaml. This configuration file extracts away the virtual machine, Lima and Hypervisor configuration."

What should the content say or communicate?
Should this be abstracts away instead of extracts away?