Micha Reiser
7a6b79d37e
Small documentation improvements ( #1606 )
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
2025-11-21 10:24:10 +01:00
Joren Hammudoglu
e663c524c2
ty badge (#897 )
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
CI / mkdocs (push) Has been cancelled
2025-07-28 20:35:08 +01:00
David Peter
f867272b3a
Update documentation links to point to https://docs.astral.sh/ty/
2025-07-02 09:40:49 -05:00
Daniel Hollas
2b9ea7e899
Add link to playground to README.md ( #440 )
2025-05-20 14:48:54 -04:00
Emil Sadek
4ad13f211d
Add: README badges ( #432 )
...
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
CI / Check generated files unedited (push) Has been cancelled
Co-authored-by: Emil Sadek <esadek@users.noreply.github.com>
Co-authored-by: Micha Reiser <micha@reiser.io>
2025-05-17 16:35:29 +00:00
Zanie Blue
6fe5309889
Fix typo ( #340 )
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
2025-05-13 00:21:29 +00:00
Zanie Blue
994caa6fcc
Rewrite the getting started documentation ( #329 )
...
[Rendered](https://github.com/astral-sh/ty/tree/zb/getting-started?tab=readme-ov-file#getting-started )
2025-05-12 14:59:43 -05:00
Zanie Blue
86cd1f1229
Update top-level warning ( #334 )
2025-05-12 14:27:48 -05:00
Zanie Blue
5f9803b4fa
Split the documentation out of the top-level README ( #331 )
...
Moves most of the documentation into a dedicated `docs/README` to make
it easier to reach important content in the top-level readme like
"getting involved".
There are some minor changes to the heading levels here and link
changes, but otherwise the content is the same. Don't go deep on the
getting started section, that's changing in #329
2025-05-12 13:45:02 -05:00
Micha Reiser
43694cc492
Add "rules" and "checking a project" sections ( #327 )
...
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
## Summary
Add documentation about what rules are and how to type check a project
2025-05-12 11:52:23 -05:00
Soof Golan
1c2fd2f114
Ensure ty runs at latest version ( #316 )
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
2025-05-12 08:40:49 +02:00
Micha Reiser
45a21f5566
Document suppressions and exit codes ( #295 )
...
CI / python package (push) Has been cancelled
CI / pre-commit (push) Has been cancelled
Co-authored-by: Carl Meyer <carl@oddbird.net>
2025-05-10 10:40:38 +00:00
Micha Reiser
cf5f8af599
docs: Document configuration file discovery ( #294 )
2025-05-10 10:35:26 +00:00
Micha Reiser
8aead5ed83
Basic README sections ( #293 )
2025-05-10 11:32:49 +01:00
Micha Reiser
b3073684d0
Reference documentation ( #292 )
2025-05-10 10:26:31 +00:00
Nameless
840f0752a3
Add CLI documentation and update README ( #284 )
...
Co-authored-by: Micha Reiser <micha@reiser.io>
2025-05-09 12:24:18 +00:00
Carl Meyer
74e72ed91a
add stronger disclaimer to README ( #254 )
...
More README updates will be coming, just want to get this in there ASAP
since we're on the front page of HN now.
---------
Co-authored-by: Charlie Marsh <crmarsh416@gmail.com>
2025-05-07 12:43:51 -07:00
Micha Reiser
9cc1742c62
Update README.md ( #70 )
2025-05-07 14:47:41 +00:00
Zanie Blue
51edd23fa8
Drop Apache reference ( #25 )
2025-05-05 08:30:02 -05:00
Zanie Blue
750b3a33f8
Update contributing guide for ruff commit changes ( #3 )
2025-05-05 11:49:06 +02:00
Zanie Blue
3d95351404
Initial commit
2025-05-02 11:37:31 -05:00
