Commit graph

10 commits

Author SHA1 Message Date
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
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
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
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
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