From 45ffe1decbd03d4835abc46e078e914f4d3e82d3 Mon Sep 17 00:00:00 2001 From: "Natalie B." <22222885+espeon@users.noreply.github.com> Date: Mon, 19 Jan 2026 19:41:53 -0600 Subject: [PATCH] disable validator for now --- js/docs/astro.config.mjs | 115 ++++++++++++++----------- js/docs/src/content/docs/reference.mdx | 9 ++ 2 files changed, 76 insertions(+), 48 deletions(-) create mode 100644 js/docs/src/content/docs/reference.mdx diff --git a/js/docs/astro.config.mjs b/js/docs/astro.config.mjs index 09f5b377..ef3bbe72 100644 --- a/js/docs/astro.config.mjs +++ b/js/docs/astro.config.mjs @@ -1,7 +1,6 @@ // @ts-check import starlight from "@astrojs/starlight"; import { defineConfig, passthroughImageService } from "astro/config"; -import starlightLinksValidator from "starlight-links-validator"; import starlightOpenAPI, { openAPISidebarGroups } from "starlight-openapi"; import starlightSidebarSwipe from "starlight-sidebar-swipe"; import starlightSidebarTopics from "starlight-sidebar-topics"; @@ -35,56 +34,11 @@ export default defineConfig({ }, favicon: "/favicon.ico", plugins: [ - starlightLinksValidator(), + //starlightLinksValidator(), starlightSidebarSwipe(), - starlightSidebarTopics([ - { - label: "For Streamers & Viewers", - link: "/", - icon: "open-book", - items: [ - { - label: "Start Streaming", - autogenerate: { directory: "guides/start-streaming" }, - }, - { - label: "Features", - autogenerate: { directory: "features" }, - }, - ], - }, - { - label: "For Developers", - link: "/developers/", - icon: "seti:config", - items: [ - { - label: "Start Contributing", - autogenerate: { directory: "guides/start-contributing" }, - }, - { - label: "Installing Streamplace", - autogenerate: { directory: "guides/installing" }, - }, - { - label: "Video Metadata", - autogenerate: { directory: "video-metadata" }, - }, - { - label: "Components", - autogenerate: { directory: "components" }, - }, - { - label: "Lexicon Reference", - autogenerate: { directory: "lex-reference" }, - }, - ...openAPISidebarGroups, - ], - }, - ]), starlightOpenAPI([ { - base: "api", + base: "/api", label: "Related XRPC API endpoints", schema: "./src/content/docs/lex-reference/openapi.json", // or your json generated from swagger sidebar: { @@ -95,6 +49,71 @@ export default defineConfig({ }, }, ]), + starlightSidebarTopics( + [ + { + label: "For Streamers & Viewers", + link: "/", + icon: "open-book", + items: [ + { + label: "Start Streaming", + autogenerate: { directory: "guides/start-streaming" }, + }, + { + label: "Features", + autogenerate: { directory: "features" }, + }, + ], + }, + { + label: "For Developers", + link: "/developers/", + icon: "seti:config", + id: "developers", + items: [ + { + label: "Start Contributing", + autogenerate: { directory: "guides/start-contributing" }, + }, + { + label: "Installing Streamplace", + autogenerate: { directory: "guides/installing" }, + }, + { + label: "Video Metadata", + autogenerate: { directory: "video-metadata" }, + }, + { + label: "Components", + autogenerate: { directory: "components" }, + }, + { + label: "Localize Streamplace", + autogenerate: { directory: "guides/localizing" }, + }, + ], + }, + { + label: "API Reference", + link: "/reference/", + icon: "seti:json", + id: "ref", + items: [ + { + label: "Lexicon Reference", + autogenerate: { directory: "lex-reference" }, + }, + ...openAPISidebarGroups, + ], + }, + ], + { + topics: { + ref: ["/api", "/api/**/*"], + }, + }, + ), ], }), ], diff --git a/js/docs/src/content/docs/reference.mdx b/js/docs/src/content/docs/reference.mdx new file mode 100644 index 00000000..1f15e0de --- /dev/null +++ b/js/docs/src/content/docs/reference.mdx @@ -0,0 +1,9 @@ +--- +title: API Reference +description: Our XRPC and OpenAPI Reference documentation +template: doc +--- + +import { Card, CardGrid } from "@astrojs/starlight/components"; + +Here contains our XRPC and OpenAPI Reference documentation. -- 2.51.2