Skip to content

[doc] Update documentation and 'pages' deployment to get rid of dead links

Søren Bredlund Caspersen requested to merge soeren.b.c/bitcoin-cash-node:Dead_links_new into master

Update documentation and 'pages' deployment to get rid of dead links

Get rid of some dead links in documentation, both removing entirely dead links, and updated links that needed it. This should make links work correctly both in GitLab and on docs.bitcoincashnode.org.

One link (to src/.clang-format) could not be handled by mkdocs - probably it has issues with dotfiles. This link has been turned into a non-link.

Additionally, temporary folders created by the mkdocs deployment have been added to .gitignore:

  • files-for-mkdocs/
  • site/

Test plan

You will need the mkdocs program installed to test this - see gitlab-ci.yml's before_script section of the pages job for relevant commands.

  • On a checkout of this MR, manually perform the commands in the script section of the pages job in .gitlab-ci.yml.
  • Check that no warnings or errors are reported by the mkdocs build command
  • Run 'mkdocs serve' and inspect the documents at https://127.0.0.1:8000
  • Check that relative links work in GitLab's folder view of the documentation
Edited by freetrader

Merge request reports