PublicArchive/astral-ty
2
0
Fork 0
mirror of https://github.com/astral-sh/ty.git synced 2026-05-06 08:56:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix the docs links to the benchmark results (#2459)

Browse Source 
## Summary

This PR corrects the HTML `<src=...>` attributes in `index.md` such that
they point to the right SVG files.

Note:

1. There is a bar chart on the docs home page
<https://docs.astral.sh/ty/>.
2. There are two SVG files and we choose which one to display depending
on the theme (light or dark).
3. We currently get:
1. `ty-benchmark-cli.svg`, if we use the light theme. This has light
writing, which cannot be seen against the light theme background.
2. `ty-benchmark-cli-dark.svg`, if we use the dark theme. This does not
exist.
4. This PR changes these links so that we use
`ty-benchmark-cli-light.svg` for the light theme and
`ty-benchmark-cli.svg` for the dark theme. Both of these images already
existed.

## Test Plan

We manually compare the before and after appearance of the docs site.

### Light

| before | after |
| - | - | 
| <img width="775" height="300" alt="Screenshot 2026-01-12 at 10 17 27"
src="https://github.com/user-attachments/assets/da3854d2-49fd-4a93-980b-2fd43c059155"
/> | <img width="736" height="390" alt="Screenshot 2026-01-12 at 10 21
47"
src="https://github.com/user-attachments/assets/35ae397f-163a-411d-9470-da1a727eb261"
/> |

### Dark

| before | after |
| - | - | 
| <img width="775" height="300" alt="Screenshot 2026-01-12 at 10 17 19"
src="https://github.com/user-attachments/assets/48f0f19a-e57b-4b64-89d0-08bad5bcef60"
/> | <img width="775" height="300" alt="Screenshot 2026-01-12 at 10 21
43"
src="https://github.com/user-attachments/assets/f6c2388b-acfa-4ff1-92fd-2428c9e80d84"
/> |

## To the reviewer

The `CONTRIBUTING.md` guidelines recommend running

```shell
npx prettier --prose-wrap always --write "**/*.md"
```

after editing any markdown files. However, this changes 24 files, not
only `index.md`. Should I run this as a separate commit, a separate PR
or neither?
This commit is contained in:
Iain Stenson
2026-01-13 05:29:50 +00:00
committed by GitHub
parent 5264371179
commit c7f64046dd
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+2 -2
View File
@@ -3,11 +3,11 @@
An extremely fast Python type checker and language server, written in Rust.
<p align="center">
<img alt="Shows a bar chart with benchmark results." width="500px" src="./assets/ty-benchmark-cli.svg#only-light">
<img alt="Shows a bar chart with benchmark results." width="500px" src="./assets/ty-benchmark-cli-light.svg#only-light">
</p>
<p align="center">
<img alt="Shows a bar chart with benchmark results." width="500px" src="./assets/ty-benchmark-cli-dark.svg#only-dark">
<img alt="Shows a bar chart with benchmark results." width="500px" src="./assets/ty-benchmark-cli.svg#only-dark">
</p>
<p align="center">