Skip to content

docs: fix the reference links in SPF_BUILDER - #4914

Merged
TomOnTime merged 1 commit into
DNSControl:mainfrom
cafferata:docs/spf-builder-reference-links
Sep 19, 2026
Merged

TomOnTime merged 1 commit into
DNSControl:mainfrom
cafferata:docs/spf-builder-reference-links

Conversation

@cafferata

Copy link
Copy Markdown
Member

Follow-up to #4634. While going through the recently merged pull requests, I noticed that two links on https://docs.dnscontrol.org/language-reference/domain-modifiers/spf_builder don't work. The txtMaxSize description shows "[multiple strings][multi-string]" and "[not go higher than 450][record-size]" as plain text, because both reference definitions are on the same line in SPF_BUILDER.md, so neither is recognized as a definition. That line dates back to #1809.

This GitHub pull request puts each definition on its own line. Reference links with one definition per line render fine on GitBook, as on the "Writing new DNS providers" page.

AI-attributie

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

- Put the `[multi-string]` and `[record-size]` definitions on separate lines, so both links render instead of showing as plain text.

Refs DNSControl#4634
@cafferata

Copy link
Copy Markdown
Member Author

Here is the GitBook preview URL with the working "multiple strings" and "not go higher than 450" links:
📚 https://docs.dnscontrol.org/~/revisions/4xkuRUgZV8jwwCBsBmXH/language-reference/domain-modifiers/spf_builder

@TomOnTime
TomOnTime merged commit 2a0070a into DNSControl:main Sep 19, 2026
12 of 13 checks passed
@cafferata
cafferata deleted the docs/spf-builder-reference-links branch September 19, 2026 13:50
TomOnTime pushed a commit that referenced this pull request Sep 19, 2026
This GitHub pull request regenerates `commands/types/dnscontrol.d.ts`
with `go generate ./...`.
#4914 put the two reference
link definitions in
`documentation/language-reference/domain-modifiers/SPF_BUILDER.md` on
separate lines, but I didn't regenerate the TypeScript definitions that
are built from that page. Since then the "Check: go
(build/fmtjson/mod-tidy/generate/fmt/fix)" check fails on every pull
request based on `main`, for example
#4917, because `go
generate` leaves `dnscontrol.d.ts` modified.

The diff is only the generated file: the `[multi-string]` and
`[record-size]` definitions move to their own line, as in the
documentation. I ran `go generate ./...` on the current `main` and it
changes no other files.

Refs #4914

## AI-attributie

Assisted-by: Claude Code:claude-opus-5
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