Improve linter.md as a comprehensive getting started guide with Next Steps section #431
Conversation
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
✅ Deploy Preview for oxc-project ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…t Steps section Co-authored-by: Boshen <[email protected]>
Copilot
AI
changed the title
Copilot finished work on behalf of
Boshen
July 31, 2025 13:22
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.
This PR transforms the
src/docs/guide/usage/linter.mdpage from a basic linter documentation page into a comprehensive getting started guide for oxlint, addressing the issue request to "improve the page as a getting started page for oxlint" and "add a 'next steps' section to instruct users."What Changed
🎯 Better User Experience
📚 Enhanced Installation & Basic Usage
🚀 Comprehensive Next Steps Section
Added 8 major categories of guidance based on oxc_linter crate analysis:
.oxlintrc.jsonwith practical examples🔗 Rich Cross-References
Each section includes "Learn more" links to relevant detailed documentation pages, creating a clear learning path from basic usage to advanced features.
Visual Results
The new page structure provides a much more user-friendly experience:
Impact
This change transforms the linter documentation from a reference-style page into a proper onboarding experience that:
The page now serves as both an entry point for new users and a comprehensive guide for existing users wanting to unlock oxlint's full potential.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
cdn.jsdelivr.netnode /home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/node_modules/.bin/../vitepress/bin/vitepress.js dev(dns block)plugins.dprint.dev/home/REDACTED/work/oxc-project.github.io/oxc-project.github.io/node_modules/.pnpm/[email protected]/node_modules/dprint/dprint fmt -- src/docs/guide/usage/linter.md(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.