feat(docs): init docs

Author: 2214962083

.eslintrc

@@ -25,6 +25,12 @@
         "unicorn/prefer-node-protocol": "off"
       }
     },
+    {
+      "files": ["docs/**/*.*"],
+      "rules": {
+        "@typescript-eslint/no-require-imports": "off"
+      }
+    },
     {
       "files": [
         "**/*.md/*.*"

.gitignore

@@ -22,3 +22,13 @@ result.json
 .svelte-kit
 .eslintcache
 vite.config.ts.timestamp-*
+
+docs/.docusaurus
+docs/netlifyDeployPreview/*
+docs/changelog
+!docs/netlifyDeployPreview/index.html
+!docs/netlifyDeployPreview/_redirects
+
+docs/_dogfooding/_swizzle_theme_tests
+
+docs/i18n/**/*

.vscode/settings.json

@@ -14,20 +14,25 @@
     "cachedir",
     "ccsp",
     "Chatgpt",
+    "chedeau",
     "clsx",
     "codicon",
     "colorette",
     "consola",
+    "esbuild",
     "esno",
     "execa",
     "gptr",
+    "hideable",
     "Jinming",
     "langchain",
+    "linebreak",
     "localstorage",
     "nicepkg",
     "OPENAI",
     "OVSE",
     "ovsx",
+    "rehype",
     "tablist",
     "tabpanel",
     "tagify",

docs/README.md

@@ -0,0 +1 @@
+...no

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+}

docs/community/0-support.md

@@ -0,0 +1 @@
+# Support

docs/community/1-team.mdx

@@ -0,0 +1,13 @@
+# Team
+
+import {
+  ActiveTeamRow,
+  HonoraryAlumniTeamRow,
+  StudentFellowsTeamRow,
+} from '@site/src/components/TeamProfileCards';
+
+## Active Team {#active-team}
+
+Current members of the GPT Runner team are listed in alphabetical order below.
+
+<ActiveTeamRow />

docs/community/2-contributing.md

@@ -0,0 +1,13 @@
+---
+title: Contributing
+hide_title: true
+sidebar_label: Contributing
+---
+
+```mdx-code-block
+import Contributing, {toc as ContributingTOC} from "@site/../CONTRIBUTING.md"
+
+<Contributing />
+
+export const toc = ContributingTOC;
+```

docs/constants.ts

@@ -0,0 +1,32 @@
+export type Lang = 'en' | 'zh-CN'
+export const DEFAULT_LOCALE = 'en'
+
+// for browser
+if (typeof process === 'undefined' && typeof window !== 'undefined') {
+  (window as any).process = {
+    env: {},
+  }
+}
+
+const isNetlify = Boolean(process.env.NETLIFY)
+export const ENV = {
+  isNetlify,
+  siteName: process.env.SITE_NAME,
+  isDev: process.env.NODE_ENV === 'development',
+  isDeployPreview: isNetlify && process.env.CONTEXT === 'deploy-preview',
+  isBranchDeploy: isNetlify && process.env.CONTEXT === 'branch-deploy',
+  isBuildFast: Boolean(process.env.BUILD_FAST),
+  baseUrl: process.env.BASE_URL ?? '/',
+  isI18nStaging: process.env.I18N_STAGING === 'true',
+  currentLocale: (process.env.CURRENT_LOCALE ?? DEFAULT_LOCALE) as Lang,
+
+  crowdinToken: process.env.CROWDIN_PERSONAL_TOKEN,
+}
+
+// export const THEME_COLOR = '#19c37d'
+export const THEME_COLOR = 'rgb(25,195,125)'
+export const ORG_NAME = 'nicepkg'
+export const PROJECT_NAME = 'gpt-runner'
+export const PROJECT_DISPLAY_NAME = 'GPT Runner'
+export const GITHUB_LINK = `https://github.com/${ORG_NAME}/${PROJECT_NAME}`
+export const SITE_URL = 'http://gpt-runner.nicepkg.cn'

docs/delay-crowdin.ts

@@ -0,0 +1,25 @@
+/*
+We delay a bit the i18n staging deployment
+Because sometimes, prod + i18n-staging call this script at the exact same time
+And then both try to dl the translations at the same time, and then we have a
+409 error. This delay makes sure prod starts to dl the translations in priority
+Used in conjunction with waitForCrowdin.js (which is not enough)
+ */
+
+import { ENV, PROJECT_NAME } from './constants'
+
+async function delay(ms: number) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms)
+  })
+}
+
+if (
+  ENV.isNetlify
+  && ENV.siteName === `${PROJECT_NAME}-i18n-staging`
+) {
+  console.log(
+    `[Crowdin] Delaying the ${PROJECT_NAME}-i18n-staging deployment to avoid 409 errors`,
+  )
+  await delay(30000)
+}