Commit graph

307 commits

Author SHA1 Message Date
Jack O'Connor
42835578dd
Bump version to 0.0.2 (beta release) (#1954)
The 0.0.1 release ran into a previously-existing-but-deleted artifact on PyPI. Re-bump and re-release.
2025-12-16 11:57:31 -08:00
Zanie Blue
7494d49e1f
Add Docker install instructions (#1953)
I didn't realize we had Docker images
2025-12-16 19:47:20 +00:00
Zanie Blue
9f739f389c
"type-driven" -> "sophisticated" (#1952) 2025-12-16 19:28:09 +00:00
Jack O'Connor
b82181f8de
Bump version to 0.0.1 (beta release) (#1949) 2025-12-16 11:11:05 -08:00
Charlie Marsh
2225382037
Update benchmark image in README (#1951) 2025-12-16 18:59:47 +00:00
Charlie Marsh
05d94a5ef0
Add reference benchmarks (#1945) 2025-12-16 13:55:37 -05:00
Zanie Blue
bfa973a526
Add repair of the benchmark images to the PyPI readme transform (#1947)
```diff
diff --git a/README.md b/README.md
index 2114b0b..9d1eca4 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ An extremely fast Python type checker and language server, written in Rust.
 <br />
 
 <p align="center">
-  <img alt="Shows a bar chart with benchmark results." width="500px" src="./docs/assets/ty-benchmark-cli.svg">
+  <img alt="Shows a bar chart with benchmark results." width="500px" src="https://raw.githubusercontent.com/astral-sh/ty/0.0.1-alpha.35/docs/assets/ty-benchmark-cli.svg">
 </p>
 
 <p align="center">
@@ -47,9 +47,9 @@ To learn more about using ty, see the [documentation](https://docs.astral.sh/ty/
 
 ## Installation
 
-To install ty, see the [installation](./installation.md) documentation.
+To install ty, see the [installation](https://github.com/astral-sh/ty/blob/0.0.1-alpha.35/installation.md) documentation.
 
-To add the ty language server to your editor, see the [editor integration](./editors.md) guide.
+To add the ty language server to your editor, see the [editor integration](https://github.com/astral-sh/ty/blob/0.0.1-alpha.35/editors.md) guide.
 
 ## Getting help
 
@@ -65,7 +65,7 @@ at this time. Please [open pull requests](https://github.com/astral-sh/ruff/pull
 to anything in the `ruff` submodule (which includes all of the Rust source code).
 
 See the
-[contributing guide](./CONTRIBUTING.md) for more details.
+[contributing guide](https://github.com/astral-sh/ty/blob/0.0.1-alpha.35/CONTRIBUTING.md) for more details.
 
 ## FAQ
 
@@ -85,7 +85,7 @@ Just "ty", please.
 
 ## License
 
-ty is licensed under the MIT license ([LICENSE](LICENSE) or
+ty is licensed under the MIT license ([LICENSE](https://github.com/astral-sh/ty/blob/0.0.1-alpha.35/LICENSE) or
 <https://opensource.org/licenses/MIT>).
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ty
```
2025-12-16 11:24:58 -06:00
Zanie Blue
65c80b8b78
Simplify image rendering for GitHub README (#1946)
[Rendered](https://github.com/astral-sh/ty/tree/zb/github?tab=readme-ov-file#ty)

GitHub supports the inline svg css
2025-12-16 11:05:54 -06:00
Zanie Blue
8852f07ff4
Add documentation for --watch mode (#1944) 2025-12-16 11:00:49 -06:00
Zanie Blue
d40204535a
Update the benchmark image (#1943) 2025-12-16 11:00:40 -06:00
Zanie Blue
74fd3dca49
Add a note about the leading ! for negative exclusions (#1942) 2025-12-16 15:40:01 +00:00
Zanie Blue
c117081ced
Fix the link to the exclude setting in the "Exclusions" document (#1941) 2025-12-16 09:37:13 -06:00
Zanie Blue
b657c361be
Expand the installation documentation (#1938) 2025-12-16 15:19:35 +00:00
Zanie Blue
e52c16a93e
Include a ref to the installation document in the type checking guide (#1939) 2025-12-16 09:17:14 -06:00
Zanie Blue
6ecdc45231
Link to the "Language server" features from the "Editor integration" guide (#1937) 2025-12-16 14:56:04 +00:00
Zanie Blue
483a1be7fa
Add a "Running the type checker" heading to the guide (#1936) 2025-12-16 14:51:12 +00:00
Zanie Blue
29f6e885d2
Add benchmarks to landing pages (#1934)
[Rendered
README](https://github.com/astral-sh/ty/tree/zb/ty-bench?tab=readme-ov-file#ty)
2025-12-16 08:42:57 -06:00
Zanie Blue
236275e399
Add link to #fine-grained-incrementality (#1935) 2025-12-16 08:34:26 -06:00
David Peter
e5324bcd7f
Add incrementality section to LSP docs (#1930)
I was halfway through with designing an example here to understand
fine-grained incrementality, but ultimately, I'm not sure this is the
right place to discuss this? It is interesting in a technical talk, but
it's (ideally) really not relevant for users to understand this in
detail(?).
2025-12-16 08:25:36 -06:00
Zanie Blue
645b7412df
Add a basic FAQ section mirroring uv (#1929) 2025-12-16 14:14:24 +00:00
David Peter
f3d3b85a8f
Better inlay hint + hover example (#1933)
Thanks @AlexWaygood
2025-12-16 15:07:27 +01:00
David Peter
ca7c98b1a1
Minor fix in diagnostics section (open files vs current file) (#1931) 2025-12-16 15:06:46 +01:00
Zanie Blue
20497ec023
Refer to the "editor integration guide" instead of "editors documentation" (#1926)
Loosely depends on https://github.com/astral-sh/ty/pull/1925
2025-12-16 08:05:08 -06:00
Zanie Blue
511833e5f0
Add a "Guides" section to the documentation (#1925)
... and move Installation, Type checking, and Editor integrations there.

These pages are more "Guide" style than "Concepts"
2025-12-16 08:05:02 -06:00
Zanie Blue
7907f2dff2
Add "highlights" to the README (#1912)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
[Rendered](https://github.com/astral-sh/ty/tree/zb/highlights?tab=readme-ov-file#highlights)

Following consensus, I'll copy them into the `index.md` page of the
documentation and add links.

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-12-16 13:45:52 +00:00
Zanie Blue
a9e8f04468
Remove stale uvx reference in type checking guide (#1928) 2025-12-16 13:39:14 +00:00
David Peter
ad35c677ad
pyproject.toml: Bump development status (#1924) 2025-12-16 14:08:17 +01:00
Dhruv Manilawala
b862c2d24d
Remove deprecated setting (#1920) 2025-12-16 17:13:09 +05:30
David Peter
000bb42aff
Minor updates to the docs (#1919)
## Summary

I did a full review of all docs using Claude, and these seemed worth
fixing.
2025-12-16 11:32:14 +01:00
David Peter
3188a56be2
Bump version to 0.0.1-alpha.35 (#1918)
Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2025-12-16 10:16:06 +01:00
David Peter
524831b4a0
Minor fixes to LSP docs (#1917) 2025-12-16 09:25:09 +01:00
Zanie Blue
7f5f2fe158
Add a "type checking" page (#1915)
I was a bit unhappy that the "Introduction" had to explain concepts like
file selection and environment discovery. I also think the "Concepts"
sections didn't really make sense as "Installation" -> "Configuration",
I wanted a page for _using_ the type checker in between. This adds a new
page for "Type checking" and moves some of the content out of the
"Introduction". The "Features / Type checking" page is renamed to
"Features / Type system" to disambiguate — which I think is more
appropriate for the target readers anyway.

I think in the long run, we'll want to add "Guides" and have a "Type
checking your project", "Type checking a script", etc., but I think
that's out of scope for the beta.
2025-12-16 09:24:36 +01:00
Zanie Blue
f3407580f0
Add "backed by" note to the README (#1913)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
2025-12-15 22:02:45 -06:00
Zanie Blue
0ee1e449b9
Move "adding as a dependency ... same version" tip in installation to admonition (#1914) 2025-12-15 22:02:34 -06:00
David Peter
f312c01e5e
Document IDE / editor features (#1900)
Document the supported IDE / editor / LSP features.

I tried to group them into categorizes because a list that goes over
every single feature feels too detailed for me.
2025-12-15 22:53:05 +01:00
Zanie Blue
d83f15fe87
Link to the typing specification in the "type checking" features page (#1909)
Instead of to the top-level page which does not really seem like what I
would want if I was trying to understand supported features?
2025-12-15 15:35:57 -06:00
Zanie Blue
e1e60a7932
Update wording in link to rules reference (#1905)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
2025-12-15 15:24:59 -06:00
Zanie Blue
2e17ab9e71
Restore the ignore commentary for virtual environment diagnostics (#1907)
I dropped this in
https://github.com/astral-sh/ty/pull/1894/files#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6L52-L54

I think we should just fix this behavior in ty, but it seems appropriate
to retain the hint until then (just rephrased on a different page)
2025-12-15 15:24:50 -06:00
Zanie Blue
1e1cc28397
Adjust the admonitions in the configuration concept page (#1906) 2025-12-15 15:24:45 -06:00
Zanie Blue
1b92a453ea
Use pyproject.toml title in relevant configuration snippets (#1904) 2025-12-15 15:24:32 -06:00
Zanie Blue
e67a51fad7
Use a "warning" admonition for expensive prefix includes (#1903) 2025-12-15 15:23:08 -06:00
Zanie Blue
d4da39ad62
Add some headings to the exclusions documentation (#1902) 2025-12-15 15:23:02 -06:00
Zanie Blue
475ad9209e
Fix a typo in the language server install ref (#1901) 2025-12-15 20:42:20 +00:00
Zanie Blue
2007b27445
Restructure and reduce the README content (#1899)
Loosely corresponding to https://github.com/astral-sh/ty/pull/1894 but
with more aggressive simplifications.

As with that pull request, this doesn't add a highlights section — I'll
do that separately.


[Rendered](https://github.com/astral-sh/ty/tree/zb/ty-docs-readme?tab=readme-ov-file#ty)
2025-12-15 20:08:39 +00:00
Zanie Blue
a59098abef
Restructure the content on the "Getting started" page (#1894)
This restructures the existing "Getting started" content. I'll add more
content in a separate pull request.

Note there will be a corresponding separate update to the README
2025-12-15 12:58:37 -06:00
Zanie Blue
d2aef538d7
Change the "Getting started" title to "Introduction" (#1893)
This matches the uv repository. The Ruff repository uses "Overview".
2025-12-15 12:47:00 -06:00
Zanie Blue
dcdf92db2d
Link to the "Editors" page from the "Installation" page (#1896) 2025-12-15 12:46:42 -06:00
Zanie Blue
1514e65db4
Note that ty is a language server as well as a type checker (#1892) 2025-12-15 11:32:28 -06:00
David Peter
41f2aadf96
Type system features: minor updates (#1890) 2025-12-15 15:32:26 +01:00
David Peter
57d1b704b9
[ty] Document ty features (#1855)
Some checks are pending
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / Check generated files unedited (push) Waiting to run
CI / mkdocs (push) Waiting to run
## Summary

Document some of ty's unique type system features and add some showcases
of diagnostics.
2025-12-15 11:36:52 +01:00