ChainSafe / engineering-handbook

ChainSafe Engineering Handbook
https://handbook.chainsafe.io
Apache License 2.0
5 stars 2 forks source link

Enforce lowercase section links #71

Closed qdm12 closed 1 year ago

qdm12 commented 1 year ago

Onrender lowercases section links, so this enforces we have lowercase section links so that they work.

render[bot] commented 1 year ago

Your Render PR Server URL is https://engineering-handbook-pr-71.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-cdlnar9a6gdmg9m35kdg.

qdm12 commented 1 year ago

But maybe it makes more sense to whitelist docs dir only

Indeed :laughing: Done :wink: Also CI failed successfully, I pushed an extra commit to fix the issues (only in go.md).

Maybe we should add a markdown deadlink checker eventually as well, although it probably wouldn't be aware of how onrender lowercases section links.

mpetrunic commented 1 year ago

But maybe it makes more sense to whitelist docs dir only

Indeed laughing Done wink Also CI failed successfully, I pushed an extra commit to fix the issues (only in go.md).

Maybe we should add a markdown deadlink checker eventually as well, although it probably wouldn't be aware of how onrender lowercases section links.

Build fails if there is a dead markdown link. The only issue is linking to the section as I think it doesn't detect if there is no section like that.

Is it just me or problematic links are not printed in ci?

qdm12 commented 1 year ago

They are printed out, now it's failing because grep doesn't find any match, so it doesn't even reach the if block :smile: Small mistake from my part, it's (better be) fixed in the last commit with grep blabla || echo "".