Migrate Docs to Nextra (#320)

Co-authored-by: Lucas Janon <[email protected]>

.eslintignore

@@ -0,0 +1,7 @@
+.cache
+node_modules
+public
+.next
+.vscode
+.git
+.yarn

.eslintrc.js

@@ -9,12 +9,7 @@ const ERROR = 2;
  */
 module.exports = {
   parser: "@typescript-eslint/parser",
-  plugins: [
-    "@typescript-eslint",
-    "simple-import-sort",
-    "prettier",
-    "unused-imports",
-  ],
+  plugins: ["@typescript-eslint", "simple-import-sort", "prettier", "unused-imports"],
   extends: ["prettier"],
   env: {
     es6: true,
@@ -31,10 +26,7 @@ module.exports = {
     },
   },
   parserOptions: {
-    project: [
-      path.join(__dirname, "tsconfig.json"),
-      path.join(__dirname, "tsconfig.eslint.json"),
-    ],
+    project: [path.join(__dirname, "tsconfig.json"), path.join(__dirname, "tsconfig.eslint.json")],
   },
   rules: {
     "no-process-env": OFF,
@@ -60,4 +52,54 @@ module.exports = {
       },
     ],
   },
+  overrides: [
+    {
+      files: ["./src"],
+      plugins: ["react", "react-hooks"],
+      extends: ["plugin:@next/next/recommended", "airbnb", "airbnb-typescript"],
+      rules: {
+        "react/function-component-definition": OFF,
+        "react/prop-types": OFF,
+        "jsx-a11y/anchor-is-valid": OFF,
+        "react/require-default-props": OFF,
+        "react/jsx-props-no-spreading": OFF,
+        "react-hooks/rules-of-hooks": "error",
+        "react-hooks/exhaustive-deps": "warn",
+        "arrow-body-style": "off",
+      },
+      parserOptions: {
+        ecmaVersion: 2018,
+        sourceType: "module",
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      env: {
+        browser: true,
+        es6: true,
+      },
+      settings: {
+        react: {
+          version: "detect",
+        },
+      },
+      globals: {
+        React: true,
+        JSX: true,
+      },
+    },
+    {
+      files: ["./src/pages/**/*", "*.d.ts", "next-seo.config.js"],
+      rules: {
+        "import/no-default-export": OFF,
+      },
+    },
+    {
+      // @description Allow param reassign on redux files (immer.js)
+      files: ["*.redux.js", "*.redux.ts", "*.slice.js", "*.slice.ts", "*.reducer.ts", "*.reducer.js"],
+      rules: {
+        "no-param-reassign": OFF,
+      },
+    },
+  ],
 };

.github/workflows/deploy.yml

@@ -14,8 +14,7 @@ jobs:
       - name: Install Vercel CLI
         run: npm install --global vercel@latest
       - name: Pull Vercel Environment Information
-        run:
-          vercel pull --yes --environment=production --token=${{
+        run: vercel pull --yes --environment=production --token=${{
           secrets.VERCEL_TOKEN }}
       - name: Build Project Artifacts
         run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}

.github/workflows/update-from-toolkit.yaml

@@ -21,15 +21,15 @@ jobs:
 
       - name: Update docs
         run: |
-          mkdir -p static/packages/toolkit
-          rm -rf static/packages/toolkit/*
-          cp -r toolkit/docs/* static/packages/toolkit/
+          mkdir -p public/packages/toolkit
+          rm -rf public/packages/toolkit/*
+          cp -r toolkit/docs/* public/packages/toolkit/
           rm -rf toolkit
 
       - name: Check for changes
         id: check-changes
         run: |
-          git add static/packages/toolkit
+          git add public/packages/toolkit
           git diff --cached --exit-code || echo "::set-output name=changed::true"
 
       - name: Create Pull Request

.github/workflows/update-from-zeta-node.yaml

@@ -21,29 +21,29 @@ jobs:
 
       - name: Update module docs
         run: |
-          mkdir -p docs/architecture/modules
-          rm -rf docs/architecture/modules/*
-          cp -r node/docs/spec/* docs/architecture/modules/
+          mkdir -p src/pages/architecture/modules
+          rm -rf src/pages/architecture/modules/*
+          cp -r node/docs/spec/* src/pages/architecture/modules/
 
       - name: Update zetacored CLI docs
         run: |
-          mkdir -p docs/architecture/zetacored
-          rm -rf docs/architecture/zetacored/*
-          cp -r node/docs/cli/zetacored/* docs/architecture/zetacored/
+          mkdir -p src/pages/architecture/zetacored
+          rm -rf src/pages/architecture/zetacored/*
+          cp -r node/docs/cli/zetacored/* src/pages/architecture/zetacored/
 
       - name: Update OpenAPI specs
         run: |
-          mkdir -p static/data
-          rm -rf static/data/openapi.swagger.yaml
-          cp -r node/docs/openapi/openapi.swagger.yaml static/data/
-          echo -e "\nhost: zetachain-athens.blockpi.network/lcd/v1/public" >> static/data/openapi.swagger.yaml
+          mkdir -p public/data
+          rm -rf public/data/openapi.swagger.yaml
+          cp -r node/docs/openapi/openapi.swagger.yaml public/data/
+          echo -e "\nhost: zetachain-athens.blockpi.network/lcd/v1/public" >> public/data/openapi.swagger.yaml
           rm -rf node
 
       - name: Check for changes
         id: check-changes
         run: |
-          git add docs/architecture/modules
-          git add static/data/openapi.swagger.yaml
+          git add src/pages/architecture/modules
+          git add public/data/openapi.swagger.yaml
           git diff --cached --exit-code || echo "::set-output name=changed::true"
 
       - name: Create Pull Request

.gitignore

@@ -1,18 +1,3 @@
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
 # dependencies
 /node_modules
 /.pnp
@@ -46,6 +31,3 @@ yarn-error.log*
 
 # typescript
 *.tsbuildinfo
-
-# Sentry
-.sentryclirc

.prettierignore

@@ -0,0 +1,6 @@
+.yarn
+node_modules
+**/.next/**
+**/dist/**
+**/build/**
+**/tmp/**

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "printWidth": 120
+}

babel.config.js

@@ -1,21 +1,14 @@
 module.exports = {
   presets: [
-    require.resolve("@docusaurus/core/lib/babel/preset"),
-    // [
-    //   "next/babel",
-    //   {
-    //     "preset-react": {
-    //       runtime: "automatic",
-    //       importSource: "@emotion/react",
-    //     },
-    //   },
-    // ],
-  ],
-  plugins: [
-    ["@babel/plugin-proposal-private-methods", { loose: false }],
-    ["@babel/plugin-proposal-private-property-in-object", { loose: false }],
-    "@emotion/babel-plugin",
-    "babel-plugin-twin",
-    "babel-plugin-macros",
+    [
+      "next/babel",
+      {
+        "preset-react": {
+          runtime: "automatic",
+          importSource: "@emotion/react",
+        },
+      },
+    ],
   ],
+  plugins: ["@emotion/babel-plugin", "babel-plugin-macros"],
 };