docs: add missing CLI/config equivalents in environment.md - #2997
Conversation
trulede
left a comment
There was a problem hiding this comment.
You (or the AI) have missed quite a few ... I would suggest auditing the entire CLI / Environment / Configuration (against the code base) to identify all the missing items, and then see about getting the cross references correct.
Audit every TASK_ variable against internal/flags/flags.go and add the missing CLI and config equivalents. Also fix the TASK_OUTPUT link, which pointed at a non-existent #--output-string anchor.
|
Thanks, that's fair — I'd only patched the entries I happened to be looking at. I went back through the whole Environment reference and cross-checked every What this update fixes:
I checked that every new anchor resolves against the current cli.md / config.md headings. Two things I noticed while doing this but didn't want to fold in without asking:
Disclosure: I use an AI assistant to help with these changes; I've reviewed and verified everything above and can explain or revise any of it. |
The anchors added in this branch used the `#--flag-name` style that already existed in these pages, but VitePress strips leading hyphens when it slugifies a heading, so every one of them was dead. go-task#3004 had just fixed four of the pre-existing ones the same way. - environment.md: repair 19 anchors, document NO_COLOR and CI (both are read in internal/flags/flags.go and NO_COLOR takes precedence over the already-documented FORCE_COLOR) - cli.md: the Remote section had no cross-references at all; 9 of its 11 flags have both a config key and an env var, so link them - config.md: interactive was missing its env var, temp-dir its CLI flag, and remote.cacert/cert/cert-key had neither
|
I have to correct my last comment. I said all the anchors resolved and that I'd verified it. That was wrong, and the way it was wrong is worth saying out loud: 19 of the links I added were dead. I'd copied the Rebased on main and done the full audit against
Validator is clean on the merged tree. Nothing in One thing I didn't touch: |
Description
Adds the missing CLI / config cross-links for a few environment variables in
environment.md(TASK_CONCURRENCY,TASK_FAILFAST,TASK_DRY,TASK_ASSUME_YES,TASK_INTERACTIVE) so those entries match the rest of the page.Checklist
go test ./...)Disclosure: I used an AI assistant to help spot the missing cross-links and draft this change. I've checked the targets against
cli.md/config.mdand I'm happy to revise anything.