Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

turkycat
Copy link

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 turkycat changed the title completed the seemingly incomplete site migration to ReST completed the site conversion to ReST, glossary updated, cleanup/maintenance improvements Apr 13, 2021
@turkycat
Copy link
Author

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
Copy link
Author

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
Copy link
Author

Hello friends! Back for another friendly ping.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant