Skip to content

Improve linter.md as a comprehensive getting started guide with next steps section #430

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.

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

Closed

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 31, 2025

Transforms the linter documentation from a reference-oriented page into a comprehensive getting started guide that progressively guides users from first-time use to advanced workflows.

What Changed

Restructured for Better User Experience

  • Changed title from "Linter (oxlint)" to "Getting Started with Oxlint"
  • Reorganized content flow from basic concepts to advanced usage
  • Added clear progression paths for different user needs

Added Quick Start Section
Provides a 4-step onboarding flow:

  1. Run Oxlint instantly with npx oxlint@latest
  2. Target specific files and directories
  3. Install for regular use with package scripts
  4. Optional first configuration setup

Enhanced Installation Guide

  • Multiple installation methods (package managers, standalone binaries, try-without-installing)
  • Platform-specific instructions and system requirements
  • Clear recommendations for different use cases

Practical Usage Examples

  • Common linting patterns and commands
  • Auto-fixing workflows
  • Framework-specific configurations (React, Node.js)
  • Comment-based rule disabling

Comprehensive Next Steps Section
Added the requested next steps with 7 detailed categories:

  • Advanced Configuration: Config files, nested configs, rule browsing, auto-fixes
  • Workflow Integration: Editor extensions, CI/CD setup, git hooks
  • ESLint Migration: Gradual migration strategies and tooling
  • Advanced Use Cases: Build tool integration, large codebase strategies
  • Staying Up to Date: Changelog, roadmap, contributing guidelines
  • Troubleshooting: Performance tuning, file discovery, rule conflicts
  • Getting Help: Community resources and support channels

Improved Integration Examples

  • Copy-paste ready configurations for ESLint, lint-staged, GitHub Actions, pre-commit
  • Updated version numbers and best practices
  • More practical examples with real-world context

Why These Changes Matter

The original documentation was comprehensive but structured more as a reference than a guide. New users needed to piece together information from different sections to get started effectively. This restructure:

  • Reduces time-to-first-success with the Quick Start section
  • Provides clear next steps for continued learning and advanced usage
  • Maintains all existing information while improving discoverability
  • Serves both beginners and advanced users through progressive disclosure

The documentation now functions as both an effective onboarding experience and a comprehensive reference, with the new "Next Steps" section providing clear pathways for users to expand their Oxlint usage.


💡 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.

Copy link

netlify bot commented Jul 31, 2025

Deploy Preview for oxc-project failed.

Name Link
🔨 Latest commit e68378b
🔍 Latest deploy log https://app.netlify.com/projects/oxc-project/deploys/688b6d0c8f23310008e6c7e8

@Copilot Copilot AI changed the title [WIP] Improve the page @oxc-project/oxc-project.github.io/files/src/docs/guide/usage/linter.md as a getting started page for oxlint, add a "next steps" section to instruct users. Study @oxc-project/oxc/files/crates/oxc_linter for relevant details. Improve linter.md as a comprehensive getting started guide with next steps section Jul 31, 2025
@Copilot Copilot AI requested a review from Boshen July 31, 2025 13:21
Copilot finished work on behalf of Boshen July 31, 2025 13:21
@Boshen Boshen closed this Aug 2, 2025
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.

2 participants