Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: broken links pointing to /api #2019

Closed
HeCorr opened this issue Jan 25, 2025 · 1 comment
Closed

docs: broken links pointing to /api #2019

HeCorr opened this issue Jan 25, 2025 · 1 comment
Labels
area: docs Changes related to documentation.

Comments

@HeCorr
Copy link
Contributor

HeCorr commented Jan 25, 2025

Description

As warned by Docusaurus when building the docs:

Exhaustive list of all broken links found:
- Broken link on source page path = /next/contributing/:
   -> linking to /api
- Broken link on source page path = /next/usage/:
   -> linking to /api#exit-codes
- Broken link on source page path = /contributing/:
   -> linking to /api
- Broken link on source page path = /usage/:
   -> linking to /api#exit-codes

I am able to fix the Usage links but I'm not sure what the Contributing links should actually point to:

If you added a new field, command or flag, ensure that you add it to the [API Reference](https://taskfile.dev/api).

Should they point to Schema Reference or CLI Reference? Both seem equally relevant to that phrase.

@task-bot task-bot added the state: needs triage Waiting to be triaged by a maintainer. label Jan 25, 2025
@pd93 pd93 closed this as completed Jan 26, 2025
@pd93
Copy link
Member

pd93 commented Jan 26, 2025

Hi @HeCorr, thanks for spotting. I've pushed a fix to both the latest and next versions of the docs in f5121de.

@task-bot task-bot removed the state: needs triage Waiting to be triaged by a maintainer. label Jan 26, 2025
@pd93 pd93 added the area: docs Changes related to documentation. label Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Changes related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants