mirrors/ty
1
0
Fork 0
mirror of https://github.com/astral-sh/ty.git synced 2025-08-04 17:08:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Split the documentation out of the top-level README (#331)

Browse source 
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
This commit is contained in:
Zanie Blue 2025-05-12 13:45:02 -05:00 • committed by GitHub
parent ab530d992d
commit 5f9803b4fa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 292 additions and 284 deletions
Download patch file Download diff file Expand all files Collapse all files

10
scripts/release.sh
View file

@ -49,8 +49,8 @@ uv run --only-group release \
echo "Updating lockfile..."
uv lock
echo "Copying documentation"
cp ruff/crates/ty/docs/cli.md ./docs
cp ruff/crates/ty/docs/configuration.md ./docs
cp ./ruff/crates/ty/docs/rules.md ./docs
git add ./docs
echo "Copying reference documentation from Ruff..."
cp ruff/crates/ty/docs/cli.md ./docs/reference/
cp ruff/crates/ty/docs/configuration.md ./docs/reference/
cp ./ruff/crates/ty/docs/rules.md ./docs/reference/
git add ./docs/reference