Skip to content

docs: use a repository-relative path in the helpers.js debugging example - #4904

Merged
TomOnTime merged 2 commits into
DNSControl:mainfrom
cafferata:docs/debug-helpers-path
Sep 19, 2026
Merged

TomOnTime merged 2 commits into
DNSControl:mainfrom
cafferata:docs/debug-helpers-path

Conversation

@cafferata

Copy link
Copy Markdown
Member

Follow-up to #4827. While going through the bug fix pull requests, I noticed that the new "Debug helpers.js" section in documentation/advanced-features/debugging-with-dlv.md reads helpers.js from /Users/tlimoncelli/gitthings/dnscontrol/pkg/js/helpers.js, a path that only exists on one machine. Its two code blocks also have no language, unlike the other blocks on the page, and the second one starts with a $ prompt, so copying it doesn't work as is.

This GitHub pull request changes the path to pkg/js/helpers.js, notes that the command runs from the root of the repository, marks both blocks as shell and removes the $ prompt. I ran the updated command from the repository root and it prints 2276849648 for IP('135.181.247.240').

AI-attributie

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

…ample.

- Read `pkg/js/helpers.js` instead of a path under `/Users/tlimoncelli/`, and note that the command runs from the root of the repository.
- Mark both "Debug `helpers.js`" code blocks as `shell` and remove the `$` prompt.

Refs DNSControl#4827
@cafferata

Copy link
Copy Markdown
Member Author

Here is the GitBook preview URL with the repository-relative path in the helpers.js debugging example:
📚 https://docs.dnscontrol.org/~/revisions/3PzyS5htPbcQpc7HZ88y/developer-info/debugging-with-dlv#debug-helpers.js

@TomOnTime
TomOnTime merged commit 0a8a7b5 into DNSControl:main Sep 19, 2026
11 checks passed
@cafferata
cafferata deleted the docs/debug-helpers-path branch September 19, 2026 13:40
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