Skip to content

docs: Rework a few more oxlint docs pages#760

Merged
connorshea merged 20 commits intomainfrom
rewrite-plugins-page
Jan 5, 2026
Merged

docs: Rework a few more oxlint docs pages#760
connorshea merged 20 commits intomainfrom
rewrite-plugins-page

Conversation

@connorshea
Copy link
Member

@connorshea connorshea commented Jan 4, 2026

I have made some revisions to various pages that were updated recently. It seems like Claude hallucinated a decent number of things in that rewrite PR 🙃

  • There were a few mistakes and minor problems with the plugins page, so this fixes them.
  • It also encourages users to prefer config files for specifying plugins, over CLI flags.
  • Removes an invalid --symlinks flag mention.
  • Improves the CI page.
  • Improves the nested config page.
  • Improves the config page
  • Improves the quickstart with a note about migrating from ESLint.
  • Improves type-aware linting docs to make it clear how to enable this in-editor and to re-add some notes on upgrading TypeScript to support ts7.
  • Removes some invalid disable directive comments that the docs claimed were real.

@netlify
Copy link

netlify bot commented Jan 4, 2026

Deploy Preview for oxc-project ready!

Name Link
🔨 Latest commit 8c4f5a7
🔍 Latest deploy log https://app.netlify.com/projects/oxc-project/deploys/695bccf530a5590007df336e
😎 Deploy Preview https://deploy-preview-760--oxc-project.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@connorshea connorshea requested a review from Boshen January 4, 2026 21:54
@connorshea connorshea changed the title docs: Rewrite plugins page docs: Rework a few more oxlint docs pages Jan 4, 2026
…lag is needed for CLI usage, and that the setting is needed for editor usage.
oxlint-enable-next-line and oxlint-enable-line are not real.
"Invalid options are reported when `--type-check` is enabled" I'm actually not sure if this is true, we should maybe remove it.
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Copy link
Contributor

@camc314 camc314 left a comment

Choose a reason for hiding this comment

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

only last comment - then this looks good to me.

💪

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
connorshea and others added 2 commits January 5, 2026 07:35
Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
| Plugin name | Default | Source |
| ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `eslint` | Yes | ESLint core rules |
| `typescript` | Yes | TypeScript rules from typescript-eslint (aka `@typescript-eslint/plugin`). Type-aware rules are available in alpha using [the type-aware mode](./type-aware.md). |
Copy link
Member

Choose a reason for hiding this comment

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

should we link to the plugin repos in the table?

Copy link
Member Author

Choose a reason for hiding this comment

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

We can, but I think we should add that in a subsequent PR

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
2025/01/01 12:00:01.001000 Starting linter with 12 workers
2025/01/01 12:00:01.001000 Workload distribution: 8 programs
2025/01/01 12:00:01.002000 [1/8] Running linter on program: /path/to/project/jsconfig.json
2026/01/01 12:00:00.000000 Starting tsgolint
Copy link
Member

Choose a reason for hiding this comment

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

Nice touch 😋

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
@connorshea connorshea merged commit 4f573dd into main Jan 5, 2026
6 checks passed
@connorshea connorshea deleted the rewrite-plugins-page branch January 5, 2026 14:42
mdong1909 added a commit that referenced this pull request Jan 13, 2026
* Add llms.txt and markdown export for AI-friendly documentation (#731)

* refactor: reorganize sidebar, what is oxc and getting started (#738)

* feat: auto-redirect /blog to the latest blog post

Add dynamic redirect from /blog to the first entry in sidebar.blog.json,
eliminating the need to manually update blog links when new posts are added.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs(linter): clarify default file ignoring behavior (#737)

* Initial plan

* docs(linter): clarify what files are automatically ignored by oxlint

- Add section explaining files automatically ignored by default
- Document that .git directories are always skipped
- Document that minified files (.min., -min., _min.) are skipped
- Clarify that .gitignore is only respected in git repos
- Clarify that global .gitignore is NOT respected
- Note that hidden files are NOT automatically ignored
- Add section on disabling file ignoring with --no-ignore flag
- Improve structure with sub-headings for better organization

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

* chore: revert auto-generated sponsors.svg and add to gitignore

Revert changes to public/sponsors.svg as it's auto-generated by prebuild.
Add it to .gitignore to prevent future accidental commits.

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

* chore: remove sponsors.svg from gitignore

Remove /public/sponsors.svg from .gitignore as requested.

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

* docs(linter): update .gitignore behavior documentation

Update documentation to reflect that .gitignore files are respected
even without a Git repository, based on recent changes in oxc PR #17375.

Changes:
- config.md: Update .gitignore note to clarify it works without .git
- generated-cli.md: Update .gitignore note for consistency

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Co-authored-by: Cameron <cameron.clark@hey.com>

* feat: add blog listing page at /blog

Replace the redirect-based /blog page with an actual blog listing that
displays all posts chronologically with their publication dates, similar
to Vite's blog page.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: add Connor Shea and Brad Zacher to team page

Add Connor Shea as a core team member and Brad Zacher as a consultant
from typescript-eslint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore(deps): update github-actions (#739)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update npm packages (#740)

* chore(deps): update npm packages

* u

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Boshen <boshenc@gmail.com>

* Release 1.36.0 (#742)

* Release 1.36.0

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.com>

* chore(deps): update dependency oxc-minify to ^0.106.0 (#743)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update oxc apps (#744)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): fix @types/markdown-it-container

* add x

* chore(deps): update crate-ci/typos action to v1.40.1 (#746)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* performance.md: add a missing space (#747)

Signed-off-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>

* Restructure and rewrite most of Oxlint (#745)

* docs(oxfmt): Updates for v0.21 (#734)

* chore(deps): update crate-ci/typos action to v1.41.0 (#750)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency oxlint-tsgolint to v0.10.1 (#751)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: General improvements to linter docs (#753)

* docs: Improve the automatic fixes page to better explain when they are applied.

The previous explanation was a bit ambiguous about how they worked.

* Rewording and minor phrasing improvements.

* Fix title on CI page.

* Clarify multi-file analysis phrasing.

* docs: `oxlint/migrate` should be used to replace ESLint in a project, and so should be listed here as well.

Performing a full migration is basically the whole point of the tool :)

* Phrasing update.

* Update editors.md to emphasize compatibility with Cursor.

* Update JS Plugins docs to clarify ESLint API support and the lack of support for particularly old/unmaintained plugins.

Adds an explicit note that the API compatibility goal generally only applies to ESLint's API as of v9 or higher.

* Add an example of a scoped plugin to js-plugins.md.

I actually did not see a single test case in the oxc repo for resolving scoped plugin names, but I know they work. We should probably add a test over there.

* Add a note that `oxlint-disable` directives are supported in JS plugins.

* Add a config file example for multi-file analaysis.

* Remove duplication.

* Phrasing.

* chore(deps): update taiki-e/install-action action to v2.65.12 (#756)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update pnpm to v10.27.0 (#757)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Add "quick start" section to "Migrate from Prettier" page (#761)

* formatter: Add a quick start guide

I think the bunx command will work but I'm admittedly not totally sure.

Regardless, this should work as a quick setup guide.

* Simplify the migration doc a bit more.

* Rephrase.

* Rephrase

* Release 1.37.0 (#762)

* Release 1.37.0

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.com>

* docs: Rework a few more oxlint docs pages (#760)

* docs: Update the plugins page to emphasize config file usage and improve wording.

* A few more minor improvements.

* Update quickstart to remove a reference to `--symlinks`, which has been removed from oxlint.

* Rephrase nested config page a bit.

* Update ci.md with more info and clarifications.

Make it clear that some of these things are third-party integrations.

* Add a note about migrating from ESLint to quickstart.

And remove the `-c` usage, as it's not necessary.

* Reword parts of the config page.

* Add more info around type-aware linting, ensure it's clear that the flag is needed for CLI usage, and that the setting is needed for editor usage.

* Phrasing.

* Add gitlab and junit formats to the quickstart list.

* Remove more hallucinations.

oxlint-enable-next-line and oxlint-enable-line are not real.

* Fix header depth.

* Fix grammar.

* Update type-aware page to add back some compatibility notes.

"Invalid options are reported when `--type-check` is enabled" I'm actually not sure if this is true, we should maybe remove it.

* Update src/docs/guide/usage/linter/ci.md

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/config.md

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/ci.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/ci.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/plugins.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/plugins.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

---------

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Co-authored-by: Alexander Lichter <github@lichter.io>

* chore(deps): update oxc apps (#764)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: Update the rule count on the home page to 650+. (#759)

* chore(deps): update dependency oxc-minify to ^0.107.0 (#763)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: Update formatter.md with configuration and usage details (#752)

* Update formatter.md with configuration and usage details

Added configuration and usage instructions for formatting scripts.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* enhancements after review

Updated the documentation structure for better clarity and organization.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* Fix duplicate command-line interface section in docs

Removed duplicate section on command-line interface.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* Update Command-line Interface heading level

Change heading from H3 to H2 for Command-line Interface section.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

---------

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* docs(oxfmt): Updates for v0.22 (#765)

* Release 1.38.0 (#766)

* Release 1.38.0

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.com>

* chore(deps): update oxc apps (#767)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: Remove mention of an `.oxlintignore` file as it does not work without explicitly specifying it in the CLI. (#768)

We should probably add support for this, honestly, but for now let's not confuse people/AI.

(additional clarification for our AI friends): oxlint DOES NOT support an `.oxlintignore` file out of the box. DO NOT suggest that filename or use that filename, please.

* docs: Add a "TIP" for using `ignorePatterns` in `.oxlintrc.json` (#769)

There is some irony to us having this for literally no reason (it didn't ever work, we don't specify it in the package.json command, and it duplicates the ignores from the gitignore anyway).

* chore(deps): update crate-ci/typos action to v1.42.0 (#771)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* bump dependency

* chore: add team member override

* chore: bump theme v4.0.3

* remove extra X social

* refactor: consolidate overrides.css into style.css

---------

Signed-off-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Boshen <boshenc@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Co-authored-by: Cameron <cameron.clark@hey.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>
Co-authored-by: Yuji Sugiura <6259812+leaysgur@users.noreply.github.com>
Co-authored-by: Connor Shea <connor.james.shea@gmail.com>
Co-authored-by: Alexander Lichter <github@lichter.io>
Co-authored-by: Alex Kostyniuk <kostyniuk7@gmail.com>
Co-authored-by: mdong1909 <mdong1909@users.noreply.github.com>
mdong1909 added a commit that referenced this pull request Jan 13, 2026
* chore: gitignore

* feat: first pass

* feat: first pass

* feat: Footer

* feat: Sponsors

* feat: Sponsors

* chore: bump theme version

* feat: trusted by updated

* feat: trusted by updated

* feat: feature toolbar constrained to features

* fix: extra spacer

* feat: deploy latest theme

* fix: update favicon and group icon

* fix: mobile sponsors

* fix: dropped old footer

* feat: clean up

* chore: merge conflicts

* update

* add x

* chore: bump theme

* fix: remove backer w/o image

* chore: bump theme + banner

* bump theme

* move landing page into project

* make lint pass

* make knip pass

* bump theme + adjust css usage

* use smaller logo + update og + logotypes

* update og, remove branding, make make copyright year dynamic (#741)

* remove branding page

* update og image's stylized "e"

* make copyright year dynamic

* remove spacer in landing

* update og linking

---------

Co-authored-by: mdong1909 <mdong1909@users.noreply.github.com>

* fix: add team member image size override (#772)

* Add llms.txt and markdown export for AI-friendly documentation (#731)

* refactor: reorganize sidebar, what is oxc and getting started (#738)

* feat: auto-redirect /blog to the latest blog post

Add dynamic redirect from /blog to the first entry in sidebar.blog.json,
eliminating the need to manually update blog links when new posts are added.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs(linter): clarify default file ignoring behavior (#737)

* Initial plan

* docs(linter): clarify what files are automatically ignored by oxlint

- Add section explaining files automatically ignored by default
- Document that .git directories are always skipped
- Document that minified files (.min., -min., _min.) are skipped
- Clarify that .gitignore is only respected in git repos
- Clarify that global .gitignore is NOT respected
- Note that hidden files are NOT automatically ignored
- Add section on disabling file ignoring with --no-ignore flag
- Improve structure with sub-headings for better organization

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

* chore: revert auto-generated sponsors.svg and add to gitignore

Revert changes to public/sponsors.svg as it's auto-generated by prebuild.
Add it to .gitignore to prevent future accidental commits.

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

* chore: remove sponsors.svg from gitignore

Remove /public/sponsors.svg from .gitignore as requested.

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

* docs(linter): update .gitignore behavior documentation

Update documentation to reflect that .gitignore files are respected
even without a Git repository, based on recent changes in oxc PR #17375.

Changes:
- config.md: Update .gitignore note to clarify it works without .git
- generated-cli.md: Update .gitignore note for consistency

Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Co-authored-by: Cameron <cameron.clark@hey.com>

* feat: add blog listing page at /blog

Replace the redirect-based /blog page with an actual blog listing that
displays all posts chronologically with their publication dates, similar
to Vite's blog page.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat: add Connor Shea and Brad Zacher to team page

Add Connor Shea as a core team member and Brad Zacher as a consultant
from typescript-eslint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore(deps): update github-actions (#739)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update npm packages (#740)

* chore(deps): update npm packages

* u

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Boshen <boshenc@gmail.com>

* Release 1.36.0 (#742)

* Release 1.36.0

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.com>

* chore(deps): update dependency oxc-minify to ^0.106.0 (#743)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update oxc apps (#744)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): fix @types/markdown-it-container

* add x

* chore(deps): update crate-ci/typos action to v1.40.1 (#746)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* performance.md: add a missing space (#747)

Signed-off-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>

* Restructure and rewrite most of Oxlint (#745)

* docs(oxfmt): Updates for v0.21 (#734)

* chore(deps): update crate-ci/typos action to v1.41.0 (#750)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency oxlint-tsgolint to v0.10.1 (#751)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: General improvements to linter docs (#753)

* docs: Improve the automatic fixes page to better explain when they are applied.

The previous explanation was a bit ambiguous about how they worked.

* Rewording and minor phrasing improvements.

* Fix title on CI page.

* Clarify multi-file analysis phrasing.

* docs: `oxlint/migrate` should be used to replace ESLint in a project, and so should be listed here as well.

Performing a full migration is basically the whole point of the tool :)

* Phrasing update.

* Update editors.md to emphasize compatibility with Cursor.

* Update JS Plugins docs to clarify ESLint API support and the lack of support for particularly old/unmaintained plugins.

Adds an explicit note that the API compatibility goal generally only applies to ESLint's API as of v9 or higher.

* Add an example of a scoped plugin to js-plugins.md.

I actually did not see a single test case in the oxc repo for resolving scoped plugin names, but I know they work. We should probably add a test over there.

* Add a note that `oxlint-disable` directives are supported in JS plugins.

* Add a config file example for multi-file analaysis.

* Remove duplication.

* Phrasing.

* chore(deps): update taiki-e/install-action action to v2.65.12 (#756)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update pnpm to v10.27.0 (#757)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Add "quick start" section to "Migrate from Prettier" page (#761)

* formatter: Add a quick start guide

I think the bunx command will work but I'm admittedly not totally sure.

Regardless, this should work as a quick setup guide.

* Simplify the migration doc a bit more.

* Rephrase.

* Rephrase

* Release 1.37.0 (#762)

* Release 1.37.0

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.com>

* docs: Rework a few more oxlint docs pages (#760)

* docs: Update the plugins page to emphasize config file usage and improve wording.

* A few more minor improvements.

* Update quickstart to remove a reference to `--symlinks`, which has been removed from oxlint.

* Rephrase nested config page a bit.

* Update ci.md with more info and clarifications.

Make it clear that some of these things are third-party integrations.

* Add a note about migrating from ESLint to quickstart.

And remove the `-c` usage, as it's not necessary.

* Reword parts of the config page.

* Add more info around type-aware linting, ensure it's clear that the flag is needed for CLI usage, and that the setting is needed for editor usage.

* Phrasing.

* Add gitlab and junit formats to the quickstart list.

* Remove more hallucinations.

oxlint-enable-next-line and oxlint-enable-line are not real.

* Fix header depth.

* Fix grammar.

* Update type-aware page to add back some compatibility notes.

"Invalid options are reported when `--type-check` is enabled" I'm actually not sure if this is true, we should maybe remove it.

* Update src/docs/guide/usage/linter/ci.md

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/config.md

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/ci.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/ci.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/plugins.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

* Update src/docs/guide/usage/linter/plugins.md

Co-authored-by: Alexander Lichter <github@lichter.io>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>

---------

Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Co-authored-by: Alexander Lichter <github@lichter.io>

* chore(deps): update oxc apps (#764)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: Update the rule count on the home page to 650+. (#759)

* chore(deps): update dependency oxc-minify to ^0.107.0 (#763)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: Update formatter.md with configuration and usage details (#752)

* Update formatter.md with configuration and usage details

Added configuration and usage instructions for formatting scripts.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* enhancements after review

Updated the documentation structure for better clarity and organization.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* Fix duplicate command-line interface section in docs

Removed duplicate section on command-line interface.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* Update Command-line Interface heading level

Change heading from H3 to H2 for Command-line Interface section.

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

---------

Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>

* docs(oxfmt): Updates for v0.22 (#765)

* Release 1.38.0 (#766)

* Release 1.38.0

---------

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Cameron Clark <cameron.clark@hey.com>

* chore(deps): update oxc apps (#767)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* docs: Remove mention of an `.oxlintignore` file as it does not work without explicitly specifying it in the CLI. (#768)

We should probably add support for this, honestly, but for now let's not confuse people/AI.

(additional clarification for our AI friends): oxlint DOES NOT support an `.oxlintignore` file out of the box. DO NOT suggest that filename or use that filename, please.

* docs: Add a "TIP" for using `ignorePatterns` in `.oxlintrc.json` (#769)

There is some irony to us having this for literally no reason (it didn't ever work, we don't specify it in the package.json command, and it duplicates the ignores from the gitignore anyway).

* chore(deps): update crate-ci/typos action to v1.42.0 (#771)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* bump dependency

* chore: add team member override

* chore: bump theme v4.0.3

* remove extra X social

* refactor: consolidate overrides.css into style.css

---------

Signed-off-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Boshen <boshenc@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Co-authored-by: Cameron <cameron.clark@hey.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>
Co-authored-by: Yuji Sugiura <6259812+leaysgur@users.noreply.github.com>
Co-authored-by: Connor Shea <connor.james.shea@gmail.com>
Co-authored-by: Alexander Lichter <github@lichter.io>
Co-authored-by: Alex Kostyniuk <kostyniuk7@gmail.com>
Co-authored-by: mdong1909 <mdong1909@users.noreply.github.com>

* chore(deps): bump theme

* docs: use smaller avators for sponsors

* docs: fix og image url

it should be absolute

* chore: reduce og image size

---------

Signed-off-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>
Signed-off-by: Connor Shea <connor.james.shea@gmail.com>
Signed-off-by: Alex Kostyniuk <kostyniuk7@gmail.com>
Co-authored-by: marchantweb <simon@marchantweb.com>
Co-authored-by: mdong1909 <mdong1909@users.noreply.github.com>
Co-authored-by: Boshen <boshenc@gmail.com>
Co-authored-by: Yuji Sugiura <6259812+leaysgur@users.noreply.github.com>
Co-authored-by: Michael Dong <220303712+mdong1909@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>
Co-authored-by: Cameron <cameron.clark@hey.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Co-authored-by: Daniel Scherzer <daniel.e.scherzer@gmail.com>
Co-authored-by: Connor Shea <connor.james.shea@gmail.com>
Co-authored-by: Alexander Lichter <github@lichter.io>
Co-authored-by: Alex Kostyniuk <kostyniuk7@gmail.com>
Co-authored-by: sapphi-red <49056869+sapphi-red@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.

3 participants