doc: references to unshipped documentation #32565

1. 
   fanquake commented at 2:35 pm on May 19, 2025: member

   There are currently multiple places in the --help or error output of bitcoind, that we reference markdown documentation, that we don’t ship with the binaries. i.e:

   https://github.com/bitcoin/bitcoin/blob/ff1ee102c4babadd85e4a18234061f10daaa119d/src/init.cpp#L525

   https://github.com/bitcoin/bitcoin/blob/ff1ee102c4babadd85e4a18234061f10daaa119d/src/init.cpp#L551

   https://github.com/bitcoin/bitcoin/blob/ff1ee102c4babadd85e4a18234061f10daaa119d/src/init.cpp#L1900

   https://github.com/bitcoin/bitcoin/blob/ff1ee102c4babadd85e4a18234061f10daaa119d/src/wallet/init.cpp#L69

   We should either remove these references, or ship this documentation.

2. fanquake added the label Docs on May 19, 2025
3. 
   Muniru0 commented at 4:01 pm on June 3, 2025: none

   @fanquake why not just updating the the docs to point to the online versions. e.g:

   Replace: see doc/cjdns.md

   With: see https://github.com/bitcoin/bitcoin/blob/master/doc/cjdns.md

   This make’s sure that:

   1. Accessibility: Users can easily access the documentation regardless of how they obtained the binaries.

   2. Up-to-Date Information: Linking to the online repository ensures that users are directed to the most current version of the documentation.

   3. Reduced Confusion: Eliminates references to non-existent local files, thereby reducing potential user confusion.

4. 
   Zeegaths commented at 7:49 am on June 5, 2025: none

   I think adding the online links makes sense. I would like to add them.
5. 
   Muniru0 commented at 1:28 pm on June 5, 2025: none

   @Zeegaths I think you can wait for 24hrs if still no response from @fanquake you can go ahead and start a draft PR. I can help you review it when you finalize it.
6. 
   Muniru0 commented at 1:32 pm on June 5, 2025: none

   I wanted to do it but I am currently trying to review a very interesting PR 😊.
7. 
   Zeegaths commented at 2:09 pm on June 5, 2025: none

   okay. Thankyou. I appreciate a review

   On Thu, 5 Jun 2025 at 16:32, Muniru0 @.***> wrote:

   Muniru0 left a comment (bitcoin/bitcoin#32565) https://github.com/bitcoin/bitcoin/issues/32565#issuecomment-2944359326

   I wanted to do it but I am currently trying to review a very interesting PR 😊.

   — Reply to this email directly, view it on GitHub https://github.com/bitcoin/bitcoin/issues/32565#issuecomment-2944359326, or unsubscribe https://github.com/notifications/unsubscribe-auth/AZVGWLGKNWVEZCWP7TNJVJL3CBBHPAVCNFSM6AAAAAB5N54MJKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNBUGM2TSMZSGY . You are receiving this because you were mentioned.Message ID: @.***>

8. 
   brunoerg commented at 9:38 pm on June 5, 2025: contributor

   @fanquake why not just updating the the docs to point to the online versions. e.g:

   Replace: see doc/cjdns.md

   With: see https://github.com/bitcoin/bitcoin/blob/master/doc/cjdns.md

   This make’s sure that:

   1. Accessibility: Users can easily access the documentation regardless of how they obtained the binaries.
   2. Up-to-Date Information: Linking to the online repository ensures that users are directed to the most current version of the documentation.
   3. Reduced Confusion: Eliminates references to non-existent local files, thereby reducing potential user confusion.

   We shouldn’t release software with documentation pointing to the master branch.

9. 
   Muniru0 commented at 7:01 am on June 6, 2025: none

   @fanquake why not just updating the the docs to point to the online versions. e.g: Replace: see doc/cjdns.md With: see https://github.com/bitcoin/bitcoin/blob/master/doc/cjdns.md This make’s sure that:

   1. Accessibility: Users can easily access the documentation regardless of how they obtained the binaries.
   2. Up-to-Date Information: Linking to the online repository ensures that users are directed to the most current version of the documentation.
   3. Reduced Confusion: Eliminates references to non-existent local files, thereby reducing potential user confusion.

   We shouldn’t release software with documentation pointing to the master branch.

   So that means there is no comprehensive version specific docs for stable releases ? I checked through bitcoincore.org/en/releases and came up with this something like : https://bitcoincore.org/en/releases/29.0/ . Which might not be comprehensive enough or is there something I am missing.

10. 
    Muniru0 commented at 7:02 am on June 6, 2025: none

    @Zeegaths check I hope you check the comment from @brunoerg before proceeding.
11. 
    Zeegaths commented at 5:40 pm on June 6, 2025: none

    Yeah I saw it.. so that means writing the docs again on the paths defined in the comments? and updating regularly as the online versions update?
12. 
    sipa commented at 5:57 pm on June 6, 2025: member

    You can link to the documentation in the specific releases, I guess. For example https://github.com/bitcoin/bitcoin/blob/v29.0/doc/cjdns.md for 29.0.
13. 
    Zeegaths commented at 6:05 pm on June 6, 2025: none

    Ok, thanks for the tip

    On Fri, 6 Jun 2025 at 20:57, Pieter Wuille @.***> wrote:

    sipa left a comment (bitcoin/bitcoin#32565) https://github.com/bitcoin/bitcoin/issues/32565#issuecomment-2950024257

    You can link to the documentation in the specific releases, I guess. For example https://github.com/bitcoin/bitcoin/blob/v29.0/doc/cjdns.md for 29.0.

    — Reply to this email directly, view it on GitHub https://github.com/bitcoin/bitcoin/issues/32565#issuecomment-2950024257, or unsubscribe https://github.com/notifications/unsubscribe-auth/AZVGWLC2R46MQF6HQY7QVBT3CHJBDAVCNFSM6AAAAAB5N54MJKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNJQGAZDIMRVG4 . You are receiving this because you were mentioned.Message ID: @.***>

Contributors
fanquake Muniru0 Zeegaths brunoerg sipa

Labels
Docs