Skip to content

docs: update root README.md description with current site links#2498

Merged
JoshuaKGoldberg merged 4 commits intomainfrom
root-readme-flint-site
Mar 25, 2026
Merged

docs: update root README.md description with current site links#2498
JoshuaKGoldberg merged 4 commits intomainfrom
root-readme-flint-site

Conversation

@JoshuaKGoldberg
Copy link
Copy Markdown
Collaborator

PR Checklist

Overview

Updates the explanation to be more like how we've phrased Flint recently. And finally updates the blog link posts to be Flint's, not my personal blog's.

❤️‍🔥

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 24, 2026

⚠️ No Changeset found

Latest commit: f0e3fea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
flint Ready Ready Preview, Comment Mar 25, 2026 4:36pm

Request Review

Copy link
Copy Markdown
Member

@lishaduck lishaduck left a comment

Choose a reason for hiding this comment

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

In general, much better!

It feels a little weird to be getting rid of the disclaimers when they're arguably all true, but I think Flint's probably working enough at this point that keeping the Experimental in the top is sufficient.

Copy link
Copy Markdown
Collaborator Author

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Do you see a good way to add more disclaimers back? Maybe a quote in the middle or at the end? +1 that it would be nice to be more explicit with people about the caveats.

JoshuaKGoldberg and others added 2 commits March 25, 2026 09:06
Co-authored-by: Eli <88557639+lishaduck@users.noreply.github.com>
- [If I Wrote a Linter, Part 3: Ecosystem](https://www.joshuakgoldberg.com/blog/if-i-wrote-a-linter-part-3-ecosystem)
- [If I Wrote a Linter, Part 4: Summary](https://www.joshuakgoldberg.com/blog/if-i-wrote-a-linter-part-4-summary)
- 😌 **Ergonomics**: the ease of writing rules in JavaScript or TypeScript
- ⚡️ **Performance**: much of the speed of native linters with intelligent caching and native code for bottlenecking operations
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@lishaduck would these :emoji: **Bold**:s also turn you away?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

We just posted #2456 on social media so I'd like to merge now. But feel free to push a removal of these / poke me to, I'm happy either way!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh, sorry. I hit command+enter and it started a review.

Yeah, probably

@JoshuaKGoldberg JoshuaKGoldberg merged commit b3fe90f into main Mar 25, 2026
7 of 8 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the root-readme-flint-site branch March 25, 2026 16:02
JoshuaKGoldberg added a commit that referenced this pull request Mar 30, 2026
<!-- 👋 Hi, thanks for sending a PR to flint! ❤️‍🔥
Please fill out all fields below and make sure each item is true and [x]
checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [x] Addresses an existing open ~issue~ PR: fixes
#2498 (comment)
- ~[ ] That issue was marked as [`status: accepting
prs`](https://github.com/flint-fyi/flint/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)~
- [x] Steps in
[CONTRIBUTING.md](https://github.com/flint-fyi/flint/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Further streamlines the README.md to, alas, not look like what LLMs tend
to spit out.

@lishaduck is there anything else you'd suggest we do?

❤️‍🔥

---------

Co-authored-by: Eli <88557639+lishaduck@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📝 Documentation: Point root README.md to the site

3 participants