developer.bitcoin.org icon indicating copy to clipboard operation
developer.bitcoin.org copied to clipboard

Replace links with embedded URLs by link references and targets

Open cornelius opened this issue 5 years ago • 4 comments

Due to the conversion of the docs from Markdown to RST, most links were created with embedded URLs, e.g.

`text <url>`__

This causes some duplication and makes the RST sources a bit less readable compared to using explicit link references and targets, e.g.:

text_

.. _text: url

It would be better to convert the links to use the explicit references and targets. This probably can best be done by processing the RST sources with a script and generating the necessary changes.

cornelius avatar Jul 02 '19 13:07 cornelius

@cornelius Thanks for adding a stub to fix this.

wbnns avatar Jul 03 '19 07:07 wbnns

@cornelius

This causes some duplication and makes the RST sources a bit less readable

Is this duplication visible on the web pages? Or just within the source itself? Did a cursory check on the pages and couldn't find an example (to see if it affects user experience for the reader).

wbnns avatar Jul 08 '19 06:07 wbnns

I don't think it has an effect on the generated HTML. It does make it easier to change links in the sources and it makes the sources more readable, though. So it's more about user experience for the writer. not so much the reader.

cornelius avatar Jul 08 '19 09:07 cornelius

Ok, thanks.

wbnns avatar Jul 09 '19 06:07 wbnns