zips icon indicating copy to clipboard operation
zips copied to clipboard

use URL references to protocol from README

Open zancas opened this issue 3 months ago • 2 comments

zancas avatar Oct 16 '25 21:10 zancas

If you look at the rendered version of README.rst which is https://github.com/zcash/zips/blob/publish/rendered/index.html , it does point to those URLs, but in a way that automatically uses the correct URL for light and dark modes. This PR will break that, admittedly only because the regexes at https://github.com/zcash/zips/blob/6b9931bad295afcf233b0c56a9a70a1db464e0a4/render.sh#L80-L81 are a little fragile. The regexes could be fixed.

The local copy of README.rst is supposed to point to the local rendering of protocol.pdf and protocol-dark.pdf, which it does. The GitHub README.rst rendering is supposed to point to the GitHub page for the rendering. Currently, when you're looking at the main branch it points to https://github.com/zcash/zips/blob/main/rendered/protocol/protocol.pdf which is wrong (it's a 404). It should be https://github.com/zcash/zips/blob/publish/rendered/protocol/protocol.pdf . This regressed when the renderings were moved to the publish branch.

This PR would fix that but at the expense of the local file no longer pointing to the local rendering, which I don't like. OTOH, many of the other links are broken in the local rendering. So that can probably be fixed separately. When I get around to it, I'll fix the regexes mentioned above and then merge. In the meantime, NACK because of the regression in automatic light/dark mode selection.

daira avatar Oct 17 '25 18:10 daira

Moving to draft until I have time to fix the regexes in render.sh.

daira avatar Oct 17 '25 18:10 daira