[PR #3363] [MERGED] Project-wide doc tidying #3777

New issue

Closed

opened 2026-03-16 12:02:07 +03:00 by kerem · 0 comments

kerem commented

2026-03-16 12:02:07 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hickory-dns/hickory-dns/pull/3363
Author: @cpu
Created: 11/26/2025
Status: ✅ Merged
Merged: 11/27/2025
Merged by: @cpu

Base: main ← Head: cpu-docs-jam_dev

📝 Commits (10+)

891713b cargo: remove boilerplate template comments
90067c0 cargo: remove badges metadata
eb3505f tests: remove broken readme metadata
0e0c457 crates/resolver: word-wrap Cargo.toml description
6e0bca3 docs: fix FAQ rendering
4c35e1b docs: clarify bin crate description
ebb7470 docs: remove NOTICE about project rename from crates
9dcb517 docs: describe crypto providers in top-level README
646b961 bin: rework README feature discussion
938777d bin: fold DNSSEC status into feature discussion

📊 Changes

16 files changed (+347 additions, -276 deletions)

View changed files

📝 README.md (+21 -4)
📝 bin/Cargo.toml (+4 -8)
📝 bin/README.md (+59 -23)
📝 crates/client/Cargo.toml (+3 -12)
📝 crates/client/README.md (+45 -73)
📝 crates/proto/Cargo.toml (+2 -7)
📝 crates/proto/README.md (+55 -4)
📝 crates/recursor/Cargo.toml (+1 -10)
📝 crates/recursor/README.md (+44 -5)
📝 crates/resolver/Cargo.toml (+2 -7)
📝 crates/resolver/README.md (+44 -43)
📝 crates/server/Cargo.toml (+5 -6)
📝 crates/server/README.md (+62 -39)
📝 tests/compatibility-tests/Cargo.toml (+0 -12)
📝 tests/integration-tests/Cargo.toml (+0 -12)
📝 util/Cargo.toml (+0 -11)

📄 Description

Follow-up to https://github.com/hickory-dns/hickory-dns/pull/3362

I started on this thinking that only a few tweaks were required, but as I went I kept finding more and more to do. There's no doubt a lot more improvements that could be made here, but I think this is a step in the right direction.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hickory-dns/hickory-dns/pull/3363 **Author:** [@cpu](https://github.com/cpu) **Created:** 11/26/2025 **Status:** ✅ Merged **Merged:** 11/27/2025 **Merged by:** [@cpu](https://github.com/cpu) **Base:** `main` ← **Head:** `cpu-docs-jam_dev` --- ### 📝 Commits (10+) - [`891713b`](https://github.com/hickory-dns/hickory-dns/commit/891713b0791ee354a46b90949b7d058891d5df99) cargo: remove boilerplate template comments - [`90067c0`](https://github.com/hickory-dns/hickory-dns/commit/90067c0c55084fdaee6c0baff0ca487406d2d42c) cargo: remove badges metadata - [`eb3505f`](https://github.com/hickory-dns/hickory-dns/commit/eb3505fb78d2a735b01e57d1727e45985498b475) tests: remove broken readme metadata - [`0e0c457`](https://github.com/hickory-dns/hickory-dns/commit/0e0c457a31b5d62e3df3c8dbccc5192a5cdfdee0) crates/resolver: word-wrap Cargo.toml description - [`6e0bca3`](https://github.com/hickory-dns/hickory-dns/commit/6e0bca30925d2f6413dcb0d48bf820d161e0fe39) docs: fix FAQ rendering - [`4c35e1b`](https://github.com/hickory-dns/hickory-dns/commit/4c35e1ba65ddca7b8758cf9be12e1b9571b20a09) docs: clarify bin crate description - [`ebb7470`](https://github.com/hickory-dns/hickory-dns/commit/ebb7470a907abd227131e0ee9d2edd1b66f17478) docs: remove NOTICE about project rename from crates - [`9dcb517`](https://github.com/hickory-dns/hickory-dns/commit/9dcb517e07cc2c98b5d0ec97396624ebf2546382) docs: describe crypto providers in top-level README - [`646b961`](https://github.com/hickory-dns/hickory-dns/commit/646b96174a21c471307332d4f51b1c8b2f81036a) bin: rework README feature discussion - [`938777d`](https://github.com/hickory-dns/hickory-dns/commit/938777dc1f27a98168812bedb7255a6654d7d051) bin: fold DNSSEC status into feature discussion ### 📊 Changes **16 files changed** (+347 additions, -276 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+21 -4) 📝 `bin/Cargo.toml` (+4 -8) 📝 `bin/README.md` (+59 -23) 📝 `crates/client/Cargo.toml` (+3 -12) 📝 `crates/client/README.md` (+45 -73) 📝 `crates/proto/Cargo.toml` (+2 -7) 📝 `crates/proto/README.md` (+55 -4) 📝 `crates/recursor/Cargo.toml` (+1 -10) 📝 `crates/recursor/README.md` (+44 -5) 📝 `crates/resolver/Cargo.toml` (+2 -7) 📝 `crates/resolver/README.md` (+44 -43) 📝 `crates/server/Cargo.toml` (+5 -6) 📝 `crates/server/README.md` (+62 -39) 📝 `tests/compatibility-tests/Cargo.toml` (+0 -12) 📝 `tests/integration-tests/Cargo.toml` (+0 -12) 📝 `util/Cargo.toml` (+0 -11) </details> ### 📄 Description Follow-up to https://github.com/hickory-dns/hickory-dns/pull/3362 I started on this thinking that only a few tweaks were required, but as I went I kept finding more and more to do. There's no doubt a lot more improvements that could be made here, but I think this is a step in the right direction. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>