Skip to content

docs: overhaul homepage #11345

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
Merged
merged 9 commits into from
Jul 4, 2025
Merged

docs: overhaul homepage #11345

merged 9 commits into from
Jul 4, 2025
+568 −279

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Jun 25, 2025 •
edited
Loading

PR Checklist

Overview

Overhauls the homepage to address the points in the issue. I tried make each section more clear & direct for what it was trying to convey.

The main change points are, top-to-bottom:

  1. Shrunk the big blue banner to put more information side-by-side
  2. Changed the project slogan from:
    • Previous: "The tooling that enables ESLint and Prettier to support TypeScript."
    • Updated: "Powerful static analysis for JavaScript and TypeScript."
  3. Switched the initial explainer section to start with the three main value props of the project: language support, standard (TS) rules, and typed linting. It also decreases the vertical size of the ESLint & TypeScript explanations by removing their logos and trimming down the text.
  4. Replaced the now-redundant "Why does typescript-eslint exist?" with a section for recent blog posts.
  5. Added brief explanatory text to Financial Contributors, and made the links a little more clear.
Before After
Before screenshot of the homepage top section After screenshot of the homepage top section
Before screenshot of the homepage 'Why does this project exist?' section After screenshot of the homepage 'Recent Blog Posts' section
Before screenshot of the homepage 'Financial Contributors' section screenshot of the homepage 'Financial Contributors' section

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify Netlify
Copy link

netlify bot commented Jun 25, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 55cb225
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/68666e78fef346000878b2b8
😎 Deploy Preview https://deploy-preview-11345--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 98 (no change from production)
Accessibility: 97 (🔴 down 3 from production)
Best Practices: 100 (no change from production)
SEO: 92 (🔴 down 8 from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jun 25, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 55cb225.

Command Status Duration Result
nx run-many -t typecheck ❌ Failed 2m 19s View ↗
nx run-many -t lint ❌ Failed 2m 3s View ↗
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 7s View ↗
nx run integration-tests:test ✅ Succeeded 49s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded 20s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded 9s View ↗
nx run types:build ✅ Succeeded 10s View ↗
nx run generate-configs ✅ Succeeded 12s View ↗
Additional runs (27) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-07-03 12:04:07 UTC

JoshuaKGoldberg
JoshuaKGoldberg commented Jun 25, 2025
View reviewed changes
packages/website/plugins/recent-blog-posts/index.ts
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was much more work than I'd hoped it would be. There's no exported way to get blog posts from @docusaurus/plugin-content-docs that I could find. https://www.cheehow.dev/blog/2024/04/01/show-recent-posts-in-docusaurus has a suggested strategy & links to more info. I did that at first but kept hitting tricky edge cases with the plugin. So in the end I just went with this more direct approach: manually re-reading and re-parsing the files. 🤷

JoshuaKGoldberg
JoshuaKGoldberg commented Jun 25, 2025
View reviewed changes
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review June 26, 2025 12:53
@JoshuaKGoldberg
Copy link
Member Author

I don't know why tools/scripts/generate-sponsors.mts is failing in the lint job. It's not related to this PR.

bradzacher
bradzacher previously approved these changes Jun 26, 2025
View reviewed changes
@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jun 30, 2025
JamesHenry
JamesHenry previously approved these changes Jul 2, 2025
View reviewed changes
@JoshuaKGoldberg JoshuaKGoldberg dismissed stale reviews from JamesHenry and bradzacher via 3f3f3d2 July 3, 2025 11:49
@kirkwaiblinger
Copy link
Member

There's now a "Learn More" button (next to "See the Rules") on the homepage that does the same thing as "Get Started". Is that intentional?

kirkwaiblinger
kirkwaiblinger approved these changes Jul 3, 2025
View reviewed changes
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💖

@JoshuaKGoldberg
Copy link
Member Author

JoshuaKGoldberg commented Jul 4, 2025 •
edited
Loading

There's now a "Learn More" button (next to "See the Rules") on the homepage that does the same thing as "Get Started". Is that intentional?

...-ish. I couldn't figure out a different good CTA target. 🤷 😞

The design constraint was using different CTA text to make the links not so repetitive. If anybody can think of a good workaround I would emphatically approve it.

@JoshuaKGoldberg JoshuaKGoldberg merged commit a8e038f into typescript-eslint:main Jul 4, 2025
60 of 63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kirkwaiblinger kirkwaiblinger kirkwaiblinger approved these changes

@JamesHenry JamesHenry JamesHenry left review comments

@bradzacher bradzacher bradzacher left review comments

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Homepage overhaul
4 participants
@JoshuaKGoldberg @kirkwaiblinger @JamesHenry @bradzacher