doc: Use relative markdown links #34693

pull maflcko wants to merge 1 commits into bitcoin:master from maflcko:2602-doc-rel changing 7 files +10 −10
  1. maflcko commented at 4:26 pm on February 27, 2026: member

    Using fully resolved links (to the master branch) in markdown files is problematic, because:

    • When the target file is (re)moved, such a link will be a 404
    • When reading docs for a previous commit/release, one is redirected to the master branch on such a link
    • When the target file has been updated, it may no longer apply to the commit/release one came from (changed options, etc)

    Fix all issues by using relative markdown links. Note that this only works in markdown. Also, release notes are left as-is, because they will be shared stand-alone externally, so can’t use relative links.

  2. doc: Use relative markdown links fa9d0623a3
  3. DrahtBot added the label Docs on Feb 27, 2026
  4. DrahtBot commented at 4:27 pm on February 27, 2026: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK kevkevinpal, rkrux

    If your review is incorrectly listed, please copy-paste <!–meta-tag:bot-skip–> into the comment that the bot should ignore.

  5. kevkevinpal commented at 3:46 pm on February 28, 2026: contributor

    ACK fa9d062

    It makes sense to use relative links where we can.


    I did find this line in the rpc code. Not sure if we want to update this aswell?

    0./src/rpc/blockchain.cpp:3360:        "document (<https://github.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo.md>)."
    
  6. maflcko commented at 4:20 pm on February 28, 2026: member

    I did find this line in the rpc code. Not sure if we want to update this aswell?

    That is a cpp file, which aren’t trivial to fix, see the discussion in the tracking issue #32565.

  7. kevkevinpal commented at 5:46 pm on March 1, 2026: contributor

    I did find this line in the rpc code. Not sure if we want to update this aswell?

    That is a cpp file, which aren’t trivial to fix, see the discussion in the tracking issue #32565.

    oops I thought that was docs in the .cpp file, but it’s the help text.

  8. rkrux commented at 10:59 am on March 2, 2026: contributor

    tACK fa9d0623a3153a2ea33540611c26378f05e0d7d4

    When the target file is (re)moved, such a link will be a 404

    Won’t this happen in relative links as well?

  9. maflcko commented at 11:12 am on March 2, 2026: member

    When the target file is (re)moved, such a link will be a 404

    Won’t this happen in relative links as well?

    No, when the target file is (re)moved on the master branch, the relative link on all prior commits will still work correctly, because the link target resolves relative to the prior commit.

  10. rkrux commented at 11:50 am on March 2, 2026: contributor

    No, when the target file is (re)moved on the master branch, the relative link on all prior commits will still work correctly, because the link target resolves relative to the prior commit.

    Oh, I believe this assumes that the relative link will be updated too by the author when the target file is (re)moved. That’s a fair assumption to have, something that I didn’t assume and got confused.

  11. maflcko commented at 12:05 pm on March 2, 2026: member
    Right, if the link isn’t updated at all after a (re)move, then that will always be an issue, completely unrelated to the changes here.
  12. kevkevinpal commented at 1:51 pm on March 2, 2026: contributor

    tACK fa9d062

    I did some additional grepping through the repo to make sure we didn’t miss any. Looks good to me.


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-03-04 03:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me