Benchmark chart: each number comes before its label in reading order, so screen readers and crawlers pair them wrongly

Open Beginner friendly
#236 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
react, typescript

Research direction

Start in docs/components/benchmark-chart.tsx and follow the Bar component that renders the value above the label; the pairs it maps over come from docs/config/benchmarks.ts (mixed scenario: Grit 1,180 vs Laravel 210). Give each pair a single visually-hidden sentence or aria-label in the correct order and mark the bars, raw numbers and rival logo alt aria-hidden, so one reading of the DOM gives the true pairing. Optionally add the benchmark table as plain text to llms.txt / llms-full.txt. Done when lynx -dump on the built page states each pair unambiguously.

Written by the indexing model from the issue text.

Description

bug documentation

The chart is correct visually (Grit 1,180 vs Laravel 210 req/s on the mixed scenario, docs/config/benchmarks.ts). But in DOM order a pair reads as:

[Laravel logo alt]  1,180  [bar]  Grit   210  [bar]  Laravel   5.6x faster

Bar in docs/components/benchmark-chart.tsx prints the value above the label, and the rival's logo alt comes first. A screen reader, a text-only browser, or an LLM page fetcher reads "Laravel 1,180, Grit 210", which is the reverse of the truth. I hit exactly this when reading the page through an AI fetch tool: the summary said the captions and tooltips contradict each other.

Since Grit courts AI agents (llms.txt, MCP), this matters more than usual.

Fix

  • Give each pair an aria-label / visually-hidden sentence: "Mixed workload: Grit 1,180 requests per second, Laravel 210, Grit 5.6 times faster."
  • Mark the bars and raw numbers aria-hidden.
  • Optionally include the benchmark table in llms.txt / llms-full.txt as plain text.

Done when the page text extracted with lynx -dump (or a screen reader) states each pair unambiguously.


Filed from a docs and developer-experience review of gritframework.dev and this repository (November 2026).


Generated by Claude Code

Dominant language
Go
Stars
152
Forks
20
Avg merge
1d 49m
Merged PRs (30d)
5

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MUKE-coder/grit

All issues in MUKE-coder/grit

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.