docs: migrate documentation to docusaurus + typedoc

.eslintrc.js

@@ -135,7 +135,7 @@ module.exports = {
     // let's disable the most problematic rules for now.
     // they're only disabled for .js files.
     // .ts files will need to migrate.
-    files: ['test/**/*.js', 'docs/**/*.js'],
+    files: ['test/**/*.js'],
     rules: {
       'babel/no-invalid-this': 'off',
       'func-names': 'off',
@@ -149,8 +149,8 @@ module.exports = {
       'no-multi-spaces': 'off',
     },
   }, {
-    // Disable slow rules that are not important in tests & docs (perf)
-    files: ['test/**/*', 'docs/**/*'],
+    // Disable slow rules that are not important in tests (perf)
+    files: ['test/**/*'],
     rules: {
       'import/no-extraneous-dependencies': 'off',
       // no need to check jsdoc in tests & docs
@@ -179,6 +179,11 @@ module.exports = {
     parserOptions: {
       project: ['./test/tsconfig.json'],
     },
+  }, {
+    files: ['**/tsconfig.json'],
+    rules: {
+      'json/*': ['error', { allowComments: true }],
+    },
   }],
   settings: {
     jsdoc: {
@@ -192,7 +197,15 @@ module.exports = {
     sourceType: 'script',
   },
   // TODO: un-ignore test/types/**, src/**/*.d.ts, and 'dev/**/*'
-  ignorePatterns: ['lib/**/*', 'types/**/*', 'test/types/**/*', 'src/**/*.d.ts', 'dev/**/*', '!dev/update-authors.js'],
+  ignorePatterns: [
+    'lib/**/*',
+    'types/**/*',
+    'test/types/**/*',
+    'src/**/*.d.ts',
+    'dev/**/*',
+    '!dev/update-authors.js',
+    '.typedoc-build',
+  ],
   env: {
     node: true,
     mocha: true,

.github/workflows/ci.yml

@@ -39,7 +39,7 @@ jobs:
           path: install-build-node-${{ matrix.node-version }}.tar
           retention-days: 1
   lint:
-    name: Lint code and docs
+    name: Lint code
     runs-on: ubuntu-latest
     needs: install-and-build
     steps:
@@ -54,7 +54,6 @@ jobs:
       - name: Extract artifact
         run: tar -xf install-build-node-16.tar
       - run: yarn lint-no-fix
-      - run: yarn lint-docs
   unit-test:
     strategy:
       fail-fast: false
@@ -91,7 +90,7 @@ jobs:
       - name: Unit tests (snowflake)
         run: yarn test-unit-snowflake
   docs:
-    name: Generate docs
+    name: Generate TypeDoc
     runs-on: ubuntu-latest
     needs: lint
     steps:

.gitignore

@@ -12,7 +12,7 @@ coverage
 test/tmp/*
 test/binary/tmp/*
 .vscode/
-esdoc
+.typedoc-build
 node_modules
 *.log
 /lib

README.md

@@ -1,5 +1,5 @@
-<p align="center">
-  <img src="docs/images/logo-small.png" width="100" />
+<p style="text-align: center;">
+  <img src="docs/images/logo-small.png" width="100" alt="" />
   <h1 align="center">Sequelize</h1>
 </p>
 
@@ -17,7 +17,7 @@ Sequelize is an easy-to-use and promise-based [Node.js](https://nodejs.org/en/ab
 
 Sequelize follows [Semantic Versioning](http://semver.org) and the [official Node.js LTS schedule](https://nodejs.org/en/about/releases/). Version 7 of Sequelize officially supports the Node.js versions `^12.22.0`, `^14.17,0`, `^16.0.0`. Other versions might be working as well.
 
-New to Sequelize? Take a look at the [Tutorials and Guides](https://sequelize.org/master). You might also be interested in the [API Reference](https://sequelize.org/master/identifiers).
+New to Sequelize? Take a look at the [Tutorials and Guides](https://sequelize.org). You might also be interested in the [API Reference](https://sequelize.org/v6/identifiers).
 
 Would you like to contribute? Read [our contribution guidelines](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md) to know more. There are many ways to help! 😃
 
@@ -94,15 +94,15 @@ If you have security issues to report, please refer to our [Responsible Disclosu
 ### :wrench: Tools
 
 - [CLI](https://github.com/sequelize/cli)
-- [With TypeScript](https://sequelize.org/master/manual/typescript.html)
+- [With TypeScript](https://sequelize.org/v6/manual/typescript.html)
 - [Enhanced TypeScript with decorators](https://github.com/RobinBuschmann/sequelize-typescript)
 - [For GraphQL](https://github.com/mickhansen/graphql-sequelize)
 - [For CockroachDB](https://github.com/cockroachdb/sequelize-cockroachdb)
-- [Plugins](https://sequelize.org/master/manual/resources.html)
+- [Plugins](https://sequelize.org/v6/manual/resources.html)
 - [For YugabyteDB](https://github.com/yugabyte/sequelize-yugabytedb)
 
 ### :speech_balloon: Translations
 
-- [English](https://sequelize.org/master) (OFFICIAL)
+- [English](https://sequelize.org) (OFFICIAL)
 - [中文文档](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL)