docs: expand positioning and comparisons#239
Merged
zeitlinger merged 3 commits intomainfrom Apr 28, 2026
Merged
Conversation
zeitlinger
force-pushed
the
codex/pr234-docs-only
branch
from
0fff894 to
1d80c65
Compare
zeitlinger
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Flint’s public documentation to better explain its positioning, setup/config model, and behavior across local, hooks, CI, and agentic workflows, with a dedicated comparisons page.
Changes:
- Reframes
docs/why.mdaround Flint’s core value proposition and links out to comparisons. - Expands
docs/linters.mdguidance on config conventions and clarifies scope semantics. - Adds
docs/alternatives.mdto host “why not X?” comparisons and updates README messaging accordingly.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Updates top-level messaging around defaults, config model, ownership boundaries, and links to comparisons. |
| docs/why.md | Restructures the “why” narrative into clearer value-prop sections and references the new comparisons page. |
| docs/linters.md | Adds guidance on canonical config filenames and refactors the “Scopes” section into per-scope subsections. |
| docs/alternatives.md | Introduces a dedicated comparisons page covering common alternative approaches/tools. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
zeitlinger
force-pushed
the
codex/pr234-docs-only
branch
from
e1e4c68 to
e2fb46b
Compare
martincostello
approved these changes
Apr 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
This refreshes the public docs around Flint's positioning, setup model, and linter behavior.
docs/alternatives.mdpage for comparisons with other lint runners and hook managersdocs/why.mdaround Flint's core value propositiondocs/linters.mdguidance while keeping the generated registry sections aligned with the current codebaseWhy
The docs were covering core concepts in a few different places, but the framing was still thin in some areas and missing in others. This makes the product story clearer, gives comparisons a dedicated home, and tightens the linter/setup guidance without changing runtime behavior.
Validation
cargo test readme_ -- --nocapturemise run lint:fixmise run lint