8000 Docs: Homepage overhaul · Issue #11184 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

Docs: Homepage overhaul #11184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
2 tasks done
JoshuaKGoldberg opened this issue May 6, 2025 · 0 comments
Open
2 tasks done

Docs: Homepage overhaul #11184

JoshuaKGoldberg opened this issue May 6, 2025 · 0 comments
Labels
documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this.

Comments

@JoshuaKGoldberg
Copy link
Member
JoshuaKGoldberg commented May 6, 2025 •
edited
Loading

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Last year, @ElianCodes led me through a pairing to audit the site's docs. See time ~24:45 on in https://youtu.be/Vyu8FU0VAqA?si=q8JeWxGYauNqDIMa&t=1482. It was super informative and showed a lot of IMO great improvement opportunities we could go for on, just to start, the homepage:

  • "The tooling that enables ESLint and Prettier to support TypeScript.": This is technically true but not compelling.
    • We do much more than this! We provide typed linting infrastructure and -most relevantly to what most users care about- a lot of TypeScript-specific rules
    • A nontrivial percentage of our audience already knows what ESLint + TypeScript + Prettier are. Spending multiple vertical screens of explanation over-optimizes for newcomers.
  • "Prettier": this note is really more about social proof / "used by", most users don't care about the implementation detail of our AST plumbing used by them
  • "Why does this project exist?": The “compare” isn’t actually there - we state the two tools, but not an explicit comparison. We never answer the question!
  • Financial Contributors: the docs link isn't very clear, and doesn't have a lot of supporting explanation of why you'd want to.
  • Get Started buttons: the same text appears 3 times. Consider having more variety / wording of call-to-actions.

I'd like to revamp the homepage to address these audit notes.

Affected URL(s)

https://typescript-eslint.io

Additional Info

💖

Co-authored-by: @ElianCodes
@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for team members to take a look documentation Documentation ("docs") that needs adding/updating labels May 6, 2025
@kirkwaiblinger kirkwaiblinger added team assigned A member of the typescript-eslint team should work on this. and removed triage Waiting for team members to take a look labels May 6, 2025
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue May 12, 2025
Closed
2 tasks
56FB
@JoshuaKGoldberg JoshuaKGoldberg marked this as a duplicate of #11188 May 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating team assigned A member of the typescript-eslint team should work on this.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JoshuaKGoldberg @kirkwaiblinger
0