fix: backtick http-proxy example URL to prevent broken doc links#857
fix: backtick http-proxy example URL to prevent broken doc links#857dangrondahl merged 1 commit intomainfrom
Conversation
The example URL `http://proxy-server-ip:proxy-port` in the --http-proxy flag description was being rendered as a clickable link by Mintlify, causing 79 broken-link reports across client_reference/ pages. Wrapping in backticks makes it render as inline code instead. Closes kosli-dev/docs#105
|
Claude finished @dangrondahl's task in 1m 44s —— View job PR Review: fix backtick http-proxy example URL
Static AnalysisAll checks pass:
ReviewLGTM. This is a clean, minimal fix. Changing from single quotes to backticks around the placeholder URL The change is consistent with how Go backtick-delimited strings are already used elsewhere in this file (e.g., the One minor observation (non-blocking): Line 120 has a similar pattern — What's good: Targeted fix, no unnecessary changes, clear PR description that explains the why (79 broken-link reports). Nice work. |
| orgFlag = "The Kosli organization." | ||
| hostFlag = "[defaulted] The Kosli endpoint." | ||
| httpProxyFlag = "[optional] The HTTP proxy URL including protocol and port number. e.g. 'http://proxy-server-ip:proxy-port'" | ||
| httpProxyFlag = "[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`" |
There was a problem hiding this comment.
There are other URL's not using backtics either..is that a problem and how does it work in console?
There was a problem hiding this comment.
@mbevc1
Cobra just strips backticks, so
./kosli fingerprint --help 2>&1 | grep "http-proxy"
--http-proxy http://proxy-server-ip:proxy-port [optional] The HTTP proxy URL including protocol and port number. e.g. http://proxy-server-ip:proxy-portThere was a problem hiding this comment.
Yeah, I was just focused on this particular URL as this shows up in mint broken-links
2 participants
Summary
http://proxy-server-ip:proxy-portin the--http-proxyflag description with backticks instead of single quotes, so Mintlify renders it as inline code rather than a clickable (broken) link.client_reference/pages.Closes kosli-dev/docs#105
Test plan
kosli <any-command> --helpstill shows the example URL correctly