fix config

Author: cedaraspen

docusaurus.config.ts

@@ -2,7 +2,7 @@ import type * as Preset from "@docusaurus/preset-classic";
 import type { Config } from "@docusaurus/types";
 import { themes as prismThemes } from "prism-react-renderer";
 
-const baseUrl = process.env.DOCUSAURUS_BASE_URL ?? "/";
+const baseUrl = process.env.DOCUSAURUS_BASE_URL ?? "/docs-staging/";
 
 const LATEST_DEVVIT_VERSION = "0.12"; // update-versioned-docs.mjs sets this automatically
 
@@ -43,7 +43,8 @@ const config: Config = {
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
   organizationName: "reddit", // Usually your GitHub org/user name.
-  projectName: "devvit", // Usually your repo name.
+  projectName: "reddit.github.io", // Usually your repo name.
+  trailingSlash: false,
 
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want

package.json

@@ -9,7 +9,7 @@
     "clear": "docusaurus clear",
     "deploy": "docusaurus deploy",
     "serve": "docusaurus serve",
-    "start": "yarn docs:clear && docusaurus start",
+    "start": "docusaurus start",
     "swizzle": "docusaurus swizzle",
     "typecheck": "tsc",
     "write-heading-ids": "docusaurus write-heading-ids",
@@ -18,13 +18,13 @@
     "test:types": "tsc --noEmit"
   },
   "dependencies": {
-    "@docusaurus/core": "3.8.1",
-    "@docusaurus/faster": "3.8.1",
-    "@docusaurus/plugin-content-docs": "3.8.1",
-    "@docusaurus/preset-classic": "3.8.1",
-    "@docusaurus/tsconfig": "3.8.1",
-    "@docusaurus/types": "3.8.1",
-    "@easyops-cn/docusaurus-search-local": "0.51.0",
+    "@docusaurus/core": "^3.9.2",
+    "@docusaurus/faster": "^3.9.2",
+    "@docusaurus/plugin-content-docs": "^3.9.2",
+    "@docusaurus/preset-classic": "^3.9.2",
+    "@docusaurus/tsconfig": "^3.9.2",
+    "@docusaurus/types": "^3.9.2",
+    "@easyops-cn/docusaurus-search-local": "0.52.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "glob": "10.3.10",
@@ -37,11 +37,11 @@
   },
   "devDependencies": {
     "@algolia/client-search": "^5.17.0",
-    "@docusaurus/module-type-aliases": "3.8.1",
-    "@docusaurus/theme-common": "3.8.1",
+    "@docusaurus/module-type-aliases": "^3.9.2",
+    "@docusaurus/theme-common": "^3.9.2",
     "@docusaurus/tsconfig": "3.8.1",
     "@docusaurus/types": "3.8.1",
-    "@docusaurus/utils": "3.8.1",
+    "@docusaurus/utils": "^3.9.2",
     "@types/react": "^19.0.0",
     "core-js": "^3.39.0",
     "mobx": "^6.13.5",

scripts/build-api-docs.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+echo "Building Devvit API docs..."
+
+typedoc \
+    --plugin typedoc-plugin-markdown \
+    --entryPoints '../packages/public-api/src/index.ts' \
+    --exclude "../packages/public-api/src/apis/reddit/**/*.ts" \
+    --tsconfig '../packages/public-api/tsconfig.json' \
+    --hideBreadcrumbs \
+    --disableSources \
+    --useHTMLAnchors \
+    --includeVersion \
+    --excludePrivate \
+    --excludeExternals \
+    --excludeInternal \
+    --readme none \
+    --out './docs/api/public-api'

scripts/build-reddit-api-docs.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+cd "$(dirname "$0")/.."
+echo "Building Reddit API docs..."
+
+typedoc \
+    --plugin typedoc-plugin-markdown \
+    --entryPoints '../packages/public-api/src/apis/reddit/RedditAPIClient.ts' \
+    --entryPoints '../packages/public-api/src/apis/reddit/models' \
+    --tsconfig '../packages/public-api/tsconfig.json' \
+    --hideBreadcrumbs \
+    --disableSources \
+    --includeVersion \
+    --excludePrivate \
+    --useHTMLAnchors \
+    --excludeExternals \
+    --excludeInternal \
+    --readme none \
+    --out './docs/api/redditapi'

scripts/verify-docs.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -xeuo pipefail
+
+R='\033[0;31m'   #'0;31' is Red's ANSI color code
+G='\033[0;32m'   #'0;32' is Green's ANSI color code
+RESET='\033[0m'
+
+# Run generation script
+echo "Generating API docs...";
+yarn gen:api-docs && yarn gen:reddit-api-docs
+echo "Linting API docs...";
+# Only format markdown files tracked by git (excludes submodules)
+# Explicitly exclude docs/spec/headers.md as it is a generated file that is not formatted correctly by prettier
+git ls-files '*.md' ':!/docs/spec/headers.md' | xargs npx prettier --write
+
+# Check for unstaged changes
+if [ -n "$(git status --porcelain)" ]; then
+  git status
+  git diff
+
+  # Give stdout a little time to handle all the output from git diff before printing the helpful suggestion
+  sleep 2;
+
+  echo -e "${R}The docs generation script (yarn docs:gen) resulted in unstaged changes. Please run 'devvit-docs/scripts/verify-docs.sh' and commit the generated docs.${RESET}";
+  exit 1
+else
+  echo -e "${G}Workspace clean ${RESET}";
+fi