fix base url

Author: cedaraspen

docusaurus.config.ts

@@ -2,8 +2,6 @@ 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 LATEST_DEVVIT_VERSION = "0.12"; // update-versioned-docs.mjs sets this automatically
 
 const config: Config = {
@@ -14,7 +12,7 @@ const config: Config = {
   title: "Reddit for Developers",
   tagline: "An app for anything",
   url: "https://developers.reddit.com",
-  baseUrl,
+  baseUrl: "/docs-staging/",
   onBrokenLinks: "warn",
   onBrokenMarkdownLinks: "warn",
   favicon: "/img/devvit_icon.png",

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