Skip to content

docs: fix broken links in api.md#2549

Merged
shadowspawn merged 1 commit into
yargs:mainfrom
patrickwehbe:docs/fix-broken-links-api
Jun 26, 2026
Merged

docs: fix broken links in api.md#2549
shadowspawn merged 1 commit into
yargs:mainfrom
patrickwehbe:docs/fix-broken-links-api

Conversation

@patrickwehbe

Copy link
Copy Markdown
Contributor

Two links in docs/api.md are broken on the rendered docs site.

  1. The .usage() section linked the default command docs as /docs/advanced.md#default-commands. yargs.js.org serves HTML, not the raw .md file, so that link 404s. Switched it to the same blob/main GitHub URL already used for this exact target earlier in the file (the ### Default Commands heading in advanced.md). Fixes Broken link in docs #1989.

  2. In the opt keys list, the global entry linked [reset](#reset). There is no #reset anchor (the old .reset() method was removed long ago), so the link goes nowhere. Repointed it to #global, which is the .global() section the same sentence already references.

Docs only, no code changes.

@shadowspawn
shadowspawn merged commit 7c76d0a into yargs:main Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken link in docs

2 participants