Commit graph

7 commits

Author SHA1 Message Date
David Peter
c0ebde9c99
Add typing FAQ (#2006) 2025-12-17 14:20:38 +01: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
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
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
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
Matthew Mckee
e6c0420ac6
Update mkdocs-material to 9.7.0 (#1860)
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

Mostly copied https://github.com/astral-sh/ruff/pull/21797.

## Test Plan

From contributing.md, ran:

```bash
uv pip compile docs/requirements.in -o docs/requirements.txt --universal -p 3.12
uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.yml
```
2025-12-12 10:33:53 +05:30
Renamed from mkdocs.template.yml (Browse further)