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

completed the site conversion to ReST, glossary updated, cleanup/maintenance improvements

Open turkycat opened this issue 3 years ago • 3 comments

Many terms were temporarily defined using :ref:___ <term-___> after what appears from history to be an incomplete conversion from .md to .rst. This PR completes that migration by including some work by others in the community and systematically replacing all these :ref: entries with appropriate :term:s.

Also, I've simplified many of the cases where terms or references are redefined each time they are used by defining these references within a single page and reusing them, or by defining a site-wide term in the configuration. Also cleaned up many redundant site references like :term:'miner <Miner>' where the <Miner> is redundant and unnecessary given that ReST uses case-insensitive reference matching.

deleted terms.rst, build confirms references are all replaced or updated, overview of rendered pages and link testing validates behavior.

turkycat avatar Apr 12 '21 22:04 turkycat

Did a little additional cleanup and resolved an issue causing the CI/CD pipeline to fail. I believe the original failure on dd08d1f was 'too many requests', so I didn't believe that the failure was real given that it doesn't actually seem that sphinx-build cares about Unicode characters in the configuration file, yet the pipeline failed.

I believe this changeset represents a large and needed improvement over the state of the master branch. Also, future use of the anchors added to the top of each page allow for more contextualized linking. This is similar to linking to other headers within a single page or linking to each glossary item (link takes you directly to the target element visually), yet can be used from any page on the site and aliased as necessary as I have done with 'network' and 'peer-to-peer network' examples.

turkycat avatar Apr 24 '21 02:04 turkycat

friendly ping on this.

I think it would be an ideal addition to promote cleanliness of these docs before new articles are added on Taproot and other recent changes.

turkycat avatar May 17 '21 14:05 turkycat

Hello friends! Back for another friendly ping.

turkycat avatar Nov 16 '21 02:11 turkycat