Skip to content

doc: Fix broken links in dev notes, move sections#35296

Open
maflcko wants to merge 5 commits into
bitcoin:masterfrom
maflcko:2605-doc-fix-links
Open

doc: Fix broken links in dev notes, move sections#35296
maflcko wants to merge 5 commits into
bitcoin:masterfrom
maflcko:2605-doc-fix-links

Conversation

@maflcko
Copy link
Copy Markdown
Member

@maflcko maflcko commented May 15, 2026

The anchors in isocpp links were recently broken, so fix them to point to the correct anchor.

Also, move/regroup 3 sections while touching the file.

@DrahtBot DrahtBot added the Docs label May 15, 2026
@DrahtBot
Copy link
Copy Markdown
Contributor

DrahtBot commented May 15, 2026

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

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35296.

Reviews

See the guideline for information on the review process.

Type Reviewers
Stale ACK janb84

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

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #35260 (doc: clarify test placement guidance by l0rinc)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

Copy link
Copy Markdown
Contributor

@janb84 janb84 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK fab42cf

I have validated that the fixed links indeed work (on both safari and chromium).
Also validated that there aren't any leftover broken links in the doc, regarding C++ core guidelines.
The reordering of the document seems logical to me, LGTM.

MarcoFalke added 5 commits May 15, 2026 17:31
* Remove the explicit modernize-use-nullptr rule mention, which has not been needed for years.
* Encourage devs to refer to the upstream clang-tidy rules documentation.
* Move NOLINTNEXTLINE(misc-no-recursion) into a subsection under the new clang-tidy section.
Doxygen is about the C++ comment style, so move the Python section to have all C++ style sections in one flow.
Valgrind is often used as a sanitizer, so move it closer to the Sanitizer section.
Previously, they have been in the "Tips and tricks" section, which seems a bit off.
@maflcko maflcko force-pushed the 2605-doc-fix-links branch from fadc000 to faf6afd Compare May 15, 2026 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants