The "Getting Started" on the documentation site directly tells me how to install and how to launch.

[mmmmmmmgo]

Getting Started (The Post-Credits Scene Nobody Asked For)

Dear Oxc Team,

I clicked on your "Getting Started" page with a simple dream:

• How do I install this thing? npm install or cargo install?
• How do I run it? Is there a CLI? How do I configure it?
• Where's my Hello World example?

Instead, you gave me:

• 7 industry leaders' recommendation letters (carefully formatted with job titles)
• Evan You's 50ms shock moment 🤯
• Jason Miller's epic saga: from 75 minutes to 10 seconds
• A Special Thanks section (because thanking two projects wasn't enough)

I feel like I accidentally walked into RustConf 2024's main stage during the acceptance speech, when all I wanted to ask was: "Excuse me, where's the bathroom?"

---

What I Expected vs. What I Got

What I Expected:

# Install
npm install -D oxlint

# Run
npx oxlint

# Done! 🎉

What I Got:

✅ Loading Evan You's tweet praise
✅ Loading Jason Miller's performance flex
✅ Loading 7 tech celebrities' testimonials
✅ Loading Special Thanks (because gratitude has no limits)
❌ Loading installation commands (404 Not Found)

---

Friendly Suggestions

This page shouldn't be called "Getting Started".

More accurate titles would be:

• "Why Oxc is Awesome" ⭐⭐⭐⭐⭐
• "Wall of Fame" 🏆
• "Before You Start, Let Me Tell You About Our 975% Performance Improvement" 📈
• "Oscar Thank You Speech, Extended Director's Cut" 🎬

---

The Philosophy Corner

I noticed your "Pager" shows the next page is "Linter".

So... the installation instructions are on the Linter page? 🤔

This is like printing "How to open the box" instructions inside the box.

Deeply philosophical. Very Zen. Much confusion.

---

What "Getting Started" Should Look Like

Here's a radical idea:

First Screen:

1. Installation command
2. Basic usage example
3. Link to "Next Steps"

Second Screen and Beyond:

• Your 10 pages of testimonials
• Performance charts that go brrr 📈
• Thank you speeches
• The entire IMDb credits roll

I promise I won't hit the back button. Scout's honor. 🤞

---

TL;DR

Current situation: It's like going to IKEA and being forced to watch a 30-minute documentary about Swedish design philosophy before you can see the meatballs.

Ideal situation: Show me the meatballs first. Then we can discuss Scandinavian minimalism over coffee.

---

P.S.

Your tools are probably amazing (I wouldn't know, haven't figured out how to install them yet).

But right now, your Getting Started page is giving "trust me bro" energy, except instead of one bro, it's seven very distinguished bros with impressive LinkedIn profiles.

---

Sincerely,

A developer who just wants to lint some JavaScript

(Not asking for much, just basic human needs like installation commands)

---

Actual Constructive Feedback

Move "Overview" and "Endorsements" to:

• An "About" page
• A "Why Oxc" page
• Literally anywhere that's not "Getting Started"

Put on the Getting Started page:

1. Installation (first 3 lines)
2. Basic usage (next 5 lines)
3. Your first lint (an example)
4. Where to go next (links)

Then we can be friends. 🤝

---

P.P.S: Yes, I'm aware this feedback is longer than the installation instructions would be. The irony is not lost on me. 😏

[nrayburn-tech]

All of the information you’re looking for is available on the tool specific page https://oxc.rs/docs/guide/usage/linter.html#installation.

Oxc provides more than just oxlint, so there are separate pages for each tool that contains usage information. It probably wouldn’t make sense to try and introduce every tool on a single getting started page.

The getting started page may not be what you’re familiar with and a simple discussion post with what you’ve listed as constructive feedback may lead to a change. However a post such as this one where you’re being overly critical of a product provided to you for free will typically be ignored.

[Boshen]

Some of the points are still, I'll leave this open until I get some time to improve the docs.

[Boshen]

Done in oxc-project/oxc-project.github.io#738