From e2d85aaf4576e5218fcf7b854133c2acd3efd4e7 Mon Sep 17 00:00:00 2001 From: Boshen Date: Thu, 9 Nov 2023 17:43:35 +0800 Subject: [PATCH] update --- .../biome.md => blog/2023-11-09-biome.md} | 0 docs/learn/ecosystem.md | 17 +++++++++++++++++ docs/learn/partnership.md | 10 ++++++++++ docs/learn/performance.md | 2 +- docs/learn/swc.md | 4 ---- docs/usage/linter.md | 6 ++++-- docusaurus.config.ts | 2 +- sidebars.ts | 4 ++-- 8 files changed, 35 insertions(+), 10 deletions(-) rename docs/{learn/biome.md => blog/2023-11-09-biome.md} (100%) create mode 100644 docs/learn/ecosystem.md create mode 100644 docs/learn/partnership.md delete mode 100644 docs/learn/swc.md diff --git a/docs/learn/biome.md b/docs/blog/2023-11-09-biome.md similarity index 100% rename from docs/learn/biome.md rename to docs/blog/2023-11-09-biome.md diff --git a/docs/learn/ecosystem.md b/docs/learn/ecosystem.md new file mode 100644 index 0000000000..48882029c3 --- /dev/null +++ b/docs/learn/ecosystem.md @@ -0,0 +1,17 @@ +--- +id: ecosystem +title: Ecosystem +--- + +Contributing to oxc will benefit the whole frontend development community. +It would be a great pleasure if you could join as well. + +We are being integrated into: + +## Ezno Type Checker + +## Rolldown + +## Rspack + +## Tyvm diff --git a/docs/learn/partnership.md b/docs/learn/partnership.md new file mode 100644 index 0000000000..d16a167458 --- /dev/null +++ b/docs/learn/partnership.md @@ -0,0 +1,10 @@ +--- +id: partnership +title: Partnership +--- + +Contributing to oxc will also get you to help our sister projects: + +## biome + +## swc diff --git a/docs/learn/performance.md b/docs/learn/performance.md index a4ea37bfad..4495310d59 100644 --- a/docs/learn/performance.md +++ b/docs/learn/performance.md @@ -1,6 +1,6 @@ --- id: performance -title: Pursuit of Performance +title: Performance --- # Pursuit of Performance on Building a JavaScript Compiler diff --git a/docs/learn/swc.md b/docs/learn/swc.md deleted file mode 100644 index e3b9052f13..0000000000 --- a/docs/learn/swc.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -id: swc -title: Swc ---- diff --git a/docs/usage/linter.md b/docs/usage/linter.md index 531772a0ce..6a52d60ae3 100644 --- a/docs/usage/linter.md +++ b/docs/usage/linter.md @@ -8,9 +8,11 @@ title: Linter ## Features - Runs 50 -100 times faster than ESLint, , and scales with the number of CPU cores ([Benchmark](https://github.com/oxc-project/bench-javascript-linter)). -- No configuration is required for default usage +- No configuration is required +- Convention over configuration, - Reports errors and useless code by default -- Convention over configuration +- Supports [.eslintignore](https://eslint.org/docs/latest/use/configure/ignore#the-eslintignore-file) +- Supports [ESLint comment disabling](https://eslint.org/docs/latest/use/configure/rules#disabling-rules) ## Adoptions diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 7df23d63e5..3a00d83c44 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -54,7 +54,7 @@ const config: Config = { type: 'docSidebar', position: 'left', sidebarId: 'usage', - label: 'Get Started', + label: 'Getting Started', }, { type: 'docSidebar', diff --git a/sidebars.ts b/sidebars.ts index 5485009a31..d9650fb35e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -17,6 +17,8 @@ const sidebars: SidebarsConfig = { 'contribute/showcase', ], learn: [ + 'learn/ecosystem', + 'learn/partnership', { type: 'category', label: 'Architecture', @@ -36,8 +38,6 @@ const sidebars: SidebarsConfig = { items: ['learn/ecmascript/ecma_spec', 'learn/ecmascript/grammar'], }, 'learn/performance', - 'learn/swc', - 'learn/biome', 'learn/references', ], };