docs: lift user-facing guides to recipes/, drop dangling docs/ refs #145

2026-04-24T20:13:15+08:00

razvandimescu commented

2026-04-24 20:13:15 +08:00

(Migrated from github.com)

Summary

docs/ is gitignored (internal notes); public-facing source, configs, and packaging linked to docs/implementation/*.md paths that were dead links for anyone outside the maintainer machine.
Adds four recipes under top-level recipes/ (README, dnsdist-front, doh-on-lan, odoh-upstream) and repoints every dangling reference.
Source-level pointers in src/{bootstrap_resolver,forward,serve}.rs drop to issue #122 directly — the module scope is broader than the ODoH-specific recipe. src/health.rs drops the §-ref; iOS HealthInfo remains named as the canonical consumer.

Test plan

cargo check (doc-comment edits only — no behavior change)
Verify recipes/odoh-upstream.md link resolves from numa.toml and packaging/client/{README.md,numa.toml}
Confirm no docs/implementation/ references remain in tracked public files: git grep -n 'docs/implementation'

## Summary - `docs/` is gitignored (internal notes); public-facing source, configs, and packaging linked to `docs/implementation/*.md` paths that were dead links for anyone outside the maintainer machine. - Adds four recipes under top-level `recipes/` (README, `dnsdist-front`, `doh-on-lan`, `odoh-upstream`) and repoints every dangling reference. - Source-level pointers in `src/{bootstrap_resolver,forward,serve}.rs` drop to issue #122 directly — the module scope is broader than the ODoH-specific recipe. `src/health.rs` drops the §-ref; iOS `HealthInfo` remains named as the canonical consumer. ## Test plan - [ ] `cargo check` (doc-comment edits only — no behavior change) - [ ] Verify `recipes/odoh-upstream.md` link resolves from `numa.toml` and `packaging/client/{README.md,numa.toml}` - [ ] Confirm no `docs/implementation/` references remain in tracked public files: `git grep -n 'docs/implementation'`

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: dearsky/numa#145