Skip to content

docs: fix typos and a broken anchor in the README - #4898

Merged
TomOnTime merged 1 commit into
DNSControl:mainfrom
cafferata:docs/readme-fixes
Sep 19, 2026
Merged

TomOnTime merged 1 commit into
DNSControl:mainfrom
cafferata:docs/readme-fixes

Conversation

@cafferata

Copy link
Copy Markdown
Member

A few small fixes in README.md. #4764 introduced "The official Github Action", which now reads "GitHub". #4774 renamed the provider variable in the example to DSP_ROUTE53 but dropped the trailing semicolon that the line above it has, so this adds it back. #4774 also rewrote the REV() deprecation warning without updating the date in the "Deprecation warnings (updated 2025-11-21)" heading, which now uses the merge date of #4774, 2026-08-17. While here, the "official instructions" link pointed to #1-install-the-software, an anchor that GitBook doesn't generate: GitBook uses #id-1.-install-the-software for that heading, so the link now jumps to the installation section on https://docs.dnscontrol.org/getting-started/getting-started instead of the top of the page. That anchor dates back to #1788.

AI-attributie

Assisted-by: Claude Code:claude-opus-5

- Write "GitHub" instead of "Github" in the GitHub Actions section.
- Add the missing semicolon after `NewDnsProvider("r53_main")` in the example.
- Update the date in the "Deprecation warnings" heading to 2026-08-17, when the REV() warning was rewritten.
- Link the installation instructions to `#id-1.-install-the-software`, the anchor GitBook generates for that heading.

Refs DNSControl#4764
Refs DNSControl#4774
@cafferata

Copy link
Copy Markdown
Member Author

The README isn't part of GitBook, so here is the rendered README with the fixes:
📚 https://github.com/cafferata/dnscontrol/blob/docs/readme-fixes/README.md#installation

@TomOnTime
TomOnTime merged commit e1cee04 into DNSControl:main Sep 19, 2026
11 checks passed
@cafferata
cafferata deleted the docs/readme-fixes branch September 19, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants