Refactor: upgrade to docusaurus v3 + un-uniswap

.github/workflows/lint.yaml

@@ -14,7 +14,7 @@ jobs:
       - name: Set up node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20
 
       - name: Install dependencies
         run: yarn --frozen-lockfile

CODEOWNERS

@@ -1,2 +1,2 @@
-*       @uniswap/developer-experience
+*       @t1protocol/engineering-t1 
 

CONTRIBUTING.md

@@ -17,8 +17,8 @@ Thanks for giving a little extra love to our docs site! Below are some basic gui
 Set up your fork with the following terminal commands, or an alteration of them to suit your environment:
 
 ```
-cd uniswap-docs
-git remote add upstream https://github.com/Uniswap/uniswap-docs.git
+cd docs
+git remote add upstream https://github.com/t1protocol/docs.git
 git fetch upstream
 git pull --rebase upstream main
 git checkout -b "my-contribution"

README.md

@@ -1,14 +1,14 @@
 # t1 Documentation
 
-This web application contains all documentation for t1. It was forked from the [Uniswap Docs](https://github.com/Uniswap/docs), which is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+This web application contains all documentation for t1. It was forked from the [Uniswap Docs](https://github.com/Uniswap/docs), and upgraded to use [Docusaurus 3](https://v3.docusaurus.io/), a modern static website generator.
 
 # Project Layout
 
 ### t1 documentation currently has two sections:
 - Concepts - General t1 information or concepts useful for using t1
 - API - xChainRead API documentation
 
-### TODO:
+### TODOs:
  - Add essential t1 contract docs, including technical method descriptions via `forge doc --serve`
  - ~~Add more research entries in [Research](./docs/concepts/research.md)~~
  - ~~Add all relevant glossary words and definitions in [Glossary](./docs/concepts/glossary.md)~~

config.json

@@ -1,7 +1,7 @@
 {
   "index_name": "v3-docs",
-  "start_urls": ["https://docs.uniswap.org/"],
-  "sitemap_urls": ["https://docs.uniswap.org/sitemap.xml"],
+  "start_urls": ["https://docs.t1protocol.com/"],
+  "sitemap_urls": ["https://docs.t1protocol.com/sitemap.xml"],
   "sitemap_alternate_links": true,
   "stop_urls": [],
   "selectors": {

docusaurus.config.js

@@ -1,31 +1,42 @@
-const math = require('remark-math')
-const katex = require('rehype-katex')
+const remarkMath = require('remark-math')
+const rehypeKatex = require('rehype-katex')
+const math = remarkMath.default || remarkMath
+const katex = rehypeKatex.default || rehypeKatex
 require('dotenv').config()
 
 module.exports = {
+  themes: ['@docusaurus/theme-mermaid'],
+  markdown: {
+    mermaid: true,
+  },
   customFields: {
-    // Analytics proxy URL
-    // analyticsProxyUrl: process.env.REACT_APP_AMPLITUDE_PROXY_URL,
-    // Determines if staging env
     stagingEnv: process.env.REACT_APP_STAGING,
-    // From node
     nodeEnv: process.env.NODE_ENV,
   },
   title: 't1',
   tagline: 'Documentation and Guides',
   url: 'https://docs.t1protocol.com',
   baseUrl: '/',
   onBrokenLinks: 'warn',
-  onBrokenMarkdownLinks: 'ignore',
+  onBrokenMarkdownLinks: 'warn',
   favicon: 'img/favicon.ico',
-  organizationName: 't1', // Usually your GitHub org/user name.
-  projectName: 't1-docs', // Usually your repo name.
+  organizationName: 't1protocol',
+  projectName: 't1-docs',
   themeConfig: {
     image: 'img/t1-rollup.png',
     prism: {
       additionalLanguages: ['solidity'],
     },
-    algolia: null,
+    mermaid: {
+      theme: { light: 'neutral', dark: 'dark' },
+    },
+    // not using search for now
+    // algolia: {
+    //   appId: 'PLACEHOLDER',
+    //   apiKey: 'PLACEHOLDER',
+    //   indexName: 't1-docs',
+    //   contextualSearch: true,
+    // },
     navbar: {
       title: 't1 Docs',
       items: [
@@ -42,7 +53,6 @@ module.exports = {
           className: 'V3_active',
         },
         {
-          // TODO(docs): Publish docs repo and make public at this URL
           href: 'https://github.com/t1protocol/',
           label: 'GitHub',
           position: 'right',
@@ -54,11 +64,28 @@ module.exports = {
       // style: "dark",
       links: [
         {
-          title: 'Developers',
+          title: 'Documentation',
+          items: [
+            {
+              label: 'Concepts',
+              to: '/concepts/protocol/introduction',
+            },
+            {
+              label: 'Integration',
+              to: '/integration/xChainRead/overview',
+            },
+          ],
+        },
+        {
+          title: 'Resources',
           items: [
             {
-              label: 'How it works',
-              href: 'https://www.t1protocol.com/#how-it-works',
+              label: 'Website',
+              href: 'https://www.t1protocol.com',
+            },
+            {
+              label: 'GitHub',
+              href: 'https://github.com/t1protocol',
             },
           ],
         },
@@ -70,7 +97,7 @@ module.exports = {
               href: 'https://discord.com/invite/nbvyXZHgke',
             },
             {
-              label: 'X',
+              label: 'X (Twitter)',
               href: 'https://x.com/t1protocol',
             },
             {
@@ -80,7 +107,7 @@ module.exports = {
           ],
         },
       ],
-      // copyright: `unlicensed`,
+      copyright: `© ${new Date().getFullYear()} t1 Protocol. Built with Docusaurus.`,
     },
     colorMode: {
       // "light" | "dark"
@@ -103,13 +130,12 @@ module.exports = {
           routeBasePath: '/',
           sidebarPath: require.resolve('./sidebars.js'),
           remarkPlugins: [math],
-          rehypePlugins: [katex],
+          rehypePlugins: [[katex, { strict: false }]],
           editUrl: 'https://github.com/t1protocol/docs/tree/main/',
           includeCurrentVersion: true,
         },
         theme: {
-          customCss: require.resolve('./src/css/custom.css'),
-          customCss2: require.resolve('./src/css/colors.css'),
+          customCss: [require.resolve('./src/css/custom.css'), require.resolve('./src/css/colors.css')],
         },
       },
     ],
@@ -122,5 +148,5 @@ module.exports = {
       crossorigin: 'anonymous',
     },
   ],
-  plugins: [['@saucelabs/theme-github-codeblock', {}]],
+  plugins: [],
 }