From 045218425952370162c19793dbcab8f01a9c400a Mon Sep 17 00:00:00 2001 From: Valentin Maerten Date: Fri, 8 Aug 2025 18:38:19 +0200 Subject: [PATCH] rework link --- website/src/docs/community.md | 2 +- website/src/docs/contributing.md | 14 +++++++------- website/src/docs/experiments/env-precedence.md | 2 +- website/src/docs/experiments/gentle-force.md | 2 +- website/src/docs/experiments/remote-taskfiles.md | 2 +- website/src/docs/faq.md | 2 +- website/src/docs/usage.md | 8 ++++---- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/website/src/docs/community.md b/website/src/docs/community.md index e1a7b002..4b91bc70 100644 --- a/website/src/docs/community.md +++ b/website/src/docs/community.md @@ -16,7 +16,7 @@ thankful for everyone that helps me to improve the overall experience. Many of our integrations are contributed and maintained by the community. You can view the full list of community integrations -[here](/integrations#community-integrations). +[here](./integrations.md#community-integrations). ## Installation methods diff --git a/website/src/docs/contributing.md b/website/src/docs/contributing.md index 2822a9f8..3892c14b 100644 --- a/website/src/docs/contributing.md +++ b/website/src/docs/contributing.md @@ -30,9 +30,9 @@ Studio Code][vscode-task]. you invest your time into a PR. - **Experiments** - If there is no way to make your change backward compatible then there is a procedure to introduce breaking changes into minor versions. - We call these "[experiments](/experiments/)". If you're intending to work on + We call these "[experiments](./experiments/index.md)". If you're intending to work on an experiment, then please read the - [experiments workflow](/experiments/#workflow) document carefully and submit a + [experiments workflow](./experiments/index.md#workflow) document carefully and submit a proposal first. ## 1. Setup @@ -85,16 +85,16 @@ by using `task website` (requires `nodejs` & `pnpm`). All content is written in Markdown and is located in the `website/src` directory. All Markdown documents should have an 80 character line wrap limit (enforced by Prettier). -When making a change, consider whether a change to the [Usage Guide](/usage) is +When making a change, consider whether a change to the [Usage Guide](./usage.md) is necessary. This document contains descriptions and examples of how to use Task features. If you're adding a new feature, try to find an appropriate place to add a new section. If you're updating an existing feature, ensure that the documentation and any examples are up-to-date. Ensure that any examples follow -the [Taskfile Styleguide](/styleguide). +the [Taskfile Styleguide](./styleguide.md). If you added a new command or flag, ensure that you add it to the -[CLI Reference](/reference/cli). New fields also need to be added to the -[Schema Reference](/reference/schema) and [JSON Schema][json-schema]. The +[CLI Reference](./reference/cli.md). New fields also need to be added to the +[Schema Reference](./reference/schema.md) and [JSON Schema][json-schema]. The descriptions for fields in the docs and the schema should match. ### Writing tests @@ -147,7 +147,7 @@ contributions. All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues, helping to -answer questions or contributing to other [community projects](/community). +answer questions or contributing to other [community projects](./community.md). > I'm stuck, where can I get help? diff --git a/website/src/docs/experiments/env-precedence.md b/website/src/docs/experiments/env-precedence.md index 7231bb40..5df9f3ca 100644 --- a/website/src/docs/experiments/env-precedence.md +++ b/website/src/docs/experiments/env-precedence.md @@ -27,7 +27,7 @@ This experiment breaks the following functionality: To enable this experiment, set the environment variable: `TASK_X_ENV_PRECEDENCE=1`. Check out -[our guide to enabling experiments](/experiments/#enabling-experiments) for more +[our guide to enabling experiments](./index.md#enabling-experiments) for more information. ::: diff --git a/website/src/docs/experiments/gentle-force.md b/website/src/docs/experiments/gentle-force.md index 73bd9d4c..023781a0 100644 --- a/website/src/docs/experiments/gentle-force.md +++ b/website/src/docs/experiments/gentle-force.md @@ -26,7 +26,7 @@ This experiment breaks the following functionality: To enable this experiment, set the environment variable: `TASK_X_GENTLE_FORCE=1`. Check out -[our guide to enabling experiments](/experiments/#enabling-experiments) for more +[our guide to enabling experiments](./index.md#enabling-experiments) for more information. ::: diff --git a/website/src/docs/experiments/remote-taskfiles.md b/website/src/docs/experiments/remote-taskfiles.md index 5a97f90e..afb3f36a 100644 --- a/website/src/docs/experiments/remote-taskfiles.md +++ b/website/src/docs/experiments/remote-taskfiles.md @@ -18,7 +18,7 @@ environment. They are intended for testing and feedback only. To enable this experiment, set the environment variable: `TASK_X_REMOTE_TASKFILES=1`. Check out -[our guide to enabling experiments](/experiments/#enabling-experiments) for more +[our guide to enabling experiments](./index.md#enabling-experiments) for more information. ::: diff --git a/website/src/docs/faq.md b/website/src/docs/faq.md index 374fb8c9..d957a8b3 100644 --- a/website/src/docs/faq.md +++ b/website/src/docs/faq.md @@ -27,7 +27,7 @@ be patient and avoid asking for ETAs. The best way to speed things up is to contribute to the project yourself. We always appreciate new contributors. If you are interested in contributing, check -out the [contributing guide](/contributing). +out the [contributing guide](./contributing.md). ## Why won't my task update my shell environment? diff --git a/website/src/docs/usage.md b/website/src/docs/usage.md index 0301ecca..4ecfa075 100644 --- a/website/src/docs/usage.md +++ b/website/src/docs/usage.md @@ -902,7 +902,7 @@ You can use `--force` or `-f` if you want to force a task to run even when up-to-date. Also, `task --status [tasks]...` will exit with a non-zero -[exit code](/reference/cli#exit-codes) if any of the tasks are not up-to-date. +[exit code](./reference/cli.md#exit-codes) if any of the tasks are not up-to-date. `status` can be combined with the [fingerprinting](#by-fingerprinting-locally-generated-files-and-their-sources) @@ -1478,7 +1478,7 @@ files that match that glob. Paths will always be returned as paths relative to the task directory. If you need to convert this to an absolute path, you can use the built-in `joinPath` function. There are some -[special variables](/reference/templating#special-variables) that you may find +[special variables](./reference/templating.md#special-variables) that you may find useful for this. ::: code-group @@ -1801,7 +1801,7 @@ commands are executed in the reverse order if you schedule multiple of them. ::: A special variable `.EXIT_CODE` is exposed when a command exited with a non-zero -[exit code](/reference/cli#exit-codes). You can check its presence to know if +[exit code](./reference/cli.md#exit-codes). You can check its presence to know if the task completed successfully or not: ```yaml @@ -2005,7 +2005,7 @@ tasks: ``` Warning prompts are called before executing a task. If a prompt is denied Task -will exit with [exit code](/reference/cli#exit-codes) 205. If approved, Task +will exit with [exit code](./reference/cli.md#exit-codes) 205. If approved, Task will continue as normal. ```shell