Skip to content

Commit f867272

Browse files
sharkdpzanieb
authored andcommitted
Update documentation links to point to https://docs.astral.sh/ty/
1 parent c70ae8c commit f867272

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ ty's command-line help text, and part of `docs/reference/`, are auto-generated f
1616
repository, using generation scripts that live in
1717
[`crates/ruff_dev/src/`](https://github.com/astral-sh/ruff/blob/main/crates/ruff_dev/src/):
1818

19-
- [Configuration options](docs/reference/configuration.md), from
19+
- [Configuration options](https://docs.astral.sh/ty/reference/configuration/), from
2020
[ruff/crates/ty_project/src/metadata/options.rs](https://github.com/astral-sh/ruff/blob/main/crates/ty_project/src/metadata/options.rs)
21-
- [Rules](docs/reference/rules.md), from
21+
- [Rules](https://docs.astral.sh/ty/reference/rules/), from
2222
[ruff/crates/ty_python_semantic/src/](https://github.com/astral-sh/ruff/blob/main/crates/ty_python_semantic/src/)
23-
- [Command-line interface reference](docs/reference/cli.md), from
23+
- [Command-line interface reference](https://docs.astral.sh/ty/reference/cli/), from
2424
[ruff/crates/ty/src/args.rs](https://github.com/astral-sh/ruff/blob/main/crates/ty/src/args.rs)
2525

2626
The Ruff repository is included as a submodule inside this repository to allow ty's release tags to reflect

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ Try out the [online playground](https://play.ty.dev), or run ty with
2121
uvx ty
2222
```
2323

24-
For other ways to install ty, see the [installation](./docs/README.md#installation) documentation.
24+
For other ways to install ty, see the [installation](https://docs.astral.sh/ty/installation/) documentation.
2525

2626
If you do not provide a subcommand, ty will list available commands — for detailed information about
27-
command-line options, see the [CLI reference](./docs/reference/cli.md).
27+
command-line options, see the [CLI reference](https://docs.astral.sh/ty/reference/cli/).
2828

2929
Use the `check` command to run the type checker:
3030

@@ -45,12 +45,12 @@ uvx ty check example.py
4545
When type checking, ty will find installed packages in the active virtual environment (via
4646
`VIRTUAL_ENV`) or discover a virtual environment named `.venv` in the project root or working
4747
directory. It will not find packages in non-virtual environments without specifying the target path
48-
with `--python`. See the [module discovery](./docs/README.md#module-discovery) documentation for
48+
with `--python`. See the [module discovery](https://docs.astral.sh/ty/modules/) documentation for
4949
details.
5050

5151
## Learning more
5252

53-
To learn more about using ty, see the [documentation](./docs/README.md).
53+
To learn more about using ty, see the [documentation](https://docs.astral.sh/ty/).
5454

5555
## Getting involved
5656

0 commit comments

Comments
 (0)