[PR #2790] [MERGED] README/docs cleanup #3323

New issue

Closed

opened 2026-03-16 11:37:23 +03:00 by kerem · 0 comments

kerem commented

2026-03-16 11:37:23 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hickory-dns/hickory-dns/pull/2790
Author: @djc
Created: 2/19/2025
Status: ✅ Merged
Merged: 2/20/2025
Merged by: @djc

Base: main ← Head: readme-cleanup

📝 Commits (7)

d2d5494 Move crate-specific status into crate READMEs
c505f03 Drop top-level section on dependencies and features
b54ee2d Move running section to server crate README
18a92bb Remove trivial setup and OpenSSL dependency info
317c13e Advertise consistent protocol support across crates
bc4ca34 client: add support for H3
5a1ba45 Stop advertising OpenSSL-based DNSSEC support

📊 Changes

7 files changed (+110 additions, -259 deletions)

View changed files

📝 README.md (+2 -175)
📝 bin/README.md (+40 -15)
📝 crates/client/Cargo.toml (+1 -1)
📝 crates/client/README.md (+18 -13)
📝 crates/resolver/README.md (+16 -36)
📝 crates/resolver/src/lib.rs (+8 -19)
📝 crates/server/README.md (+25 -0)

📄 Description

Update protocol support documentation and make it consistent.

@NobodyXu thanks for your work in #2758, I decided to clean it up a bit more.

Follows up from #2786.

_{🔄 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/2790 **Author:** [@djc](https://github.com/djc) **Created:** 2/19/2025 **Status:** ✅ Merged **Merged:** 2/20/2025 **Merged by:** [@djc](https://github.com/djc) **Base:** `main` ← **Head:** `readme-cleanup` --- ### 📝 Commits (7) - [`d2d5494`](https://github.com/hickory-dns/hickory-dns/commit/d2d54945041e5dcfe423a8c53c7c89ef1a0ce90d) Move crate-specific status into crate READMEs - [`c505f03`](https://github.com/hickory-dns/hickory-dns/commit/c505f03f639bda2e8d377e0781cac1b9cfb17c96) Drop top-level section on dependencies and features - [`b54ee2d`](https://github.com/hickory-dns/hickory-dns/commit/b54ee2d19a70d45533d7add22220b2142a56bb49) Move running section to server crate README - [`18a92bb`](https://github.com/hickory-dns/hickory-dns/commit/18a92bb0924466da838a3f541f82e50e033e7d4b) Remove trivial setup and OpenSSL dependency info - [`317c13e`](https://github.com/hickory-dns/hickory-dns/commit/317c13e83543451876284278f57908b35dcd54fa) Advertise consistent protocol support across crates - [`bc4ca34`](https://github.com/hickory-dns/hickory-dns/commit/bc4ca34e7e9622ad566351fb0bfbcabfe3e2d57b) client: add support for H3 - [`5a1ba45`](https://github.com/hickory-dns/hickory-dns/commit/5a1ba45f6e8dea3e896956ad297def58f70ff902) Stop advertising OpenSSL-based DNSSEC support ### 📊 Changes **7 files changed** (+110 additions, -259 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+2 -175) 📝 `bin/README.md` (+40 -15) 📝 `crates/client/Cargo.toml` (+1 -1) 📝 `crates/client/README.md` (+18 -13) 📝 `crates/resolver/README.md` (+16 -36) 📝 `crates/resolver/src/lib.rs` (+8 -19) 📝 `crates/server/README.md` (+25 -0) </details> ### 📄 Description Update protocol support documentation and make it consistent. @NobodyXu thanks for your work in #2758, I decided to clean it up a bit more. Follows up from #2786. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>