doc: give more attention to Catalina issues doc

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628

[mmarchini]

It's easy to miss the Catalina issues doc when reading the readme. Since
it can be a common issue among developers, it makes sense to give more
attention to it in the readme.

Checklist

• documentation is changed or added
• commit message follows commit guidelines

[rvagg]

I'm not sure if too many people actually come to the README for help, Google -> Issues seems to be the most common path these days. But this is fine by me.

[mmarchini]

Agreed, but even finding via Google is not so ergonomic unfortunately. Depending on the query used, the first few results Google gives you are from other unrelated repositories, and not from node-gyp (that's the result I got when searching the error on Google at least).

I also suggested adding a link to the guide on the website (nodejs/nodejs.org#3180), so at least there's another way to find it (and maybe it improves SEO for the guide? IDK how SEO works).

[rvagg]

9aed628