Commit graph

6 commits

Author SHA1 Message Date
Zanie Blue
8852f07ff4
Add documentation for --watch mode (#1944) 2025-12-16 11:00:49 -06: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
483a1be7fa
Add a "Running the type checker" heading to the guide (#1936) 2025-12-16 14:51:12 +00:00
Zanie Blue
a9e8f04468
Remove stale uvx reference in type checking guide (#1928) 2025-12-16 13:39:14 +00:00
David Peter
000bb42aff
Minor updates to the docs (#1919)
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

I did a full review of all docs using Claude, and these seemed worth
fixing.
2025-12-16 11:32:14 +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