aboutsummaryrefslogtreecommitdiff
path: root/website/scripts/check-built-docs.mjs
diff options
context:
space:
mode:
Diffstat (limited to 'website/scripts/check-built-docs.mjs')
-rw-r--r--website/scripts/check-built-docs.mjs29
1 files changed, 22 insertions, 7 deletions
diff --git a/website/scripts/check-built-docs.mjs b/website/scripts/check-built-docs.mjs
index 5bda738e..f6a2f199 100644
--- a/website/scripts/check-built-docs.mjs
+++ b/website/scripts/check-built-docs.mjs
@@ -82,23 +82,35 @@ if (!currentDocs?.tag || !currentDocs.source) {
}
const stableRawRoot = `https://raw.githubusercontent.com/herdrdev/herdr/${currentDocs.tag}`;
const stableRawBase = `${stableRawRoot}/${currentDocs.source}`;
-const previewRawBase = `https://raw.githubusercontent.com/herdrdev/herdr/${versions.preview.commit}/docs/next/website/src/content/docs`;
+const stableConfigReferenceUrl = `${stableRawRoot}/${currentDocs.source.replace(/\/content\/docs$/, '/data/config-reference.json')}`;
+const previewRawRoot = `https://raw.githubusercontent.com/herdrdev/herdr/${versions.preview.commit}`;
+const previewRawBase = `${previewRawRoot}/docs/next/website/src/content/docs`;
+const previewConfigReferenceUrl = `${previewRawRoot}/docs/next/website/src/data/config-reference.json`;
assertIncludes(llmsIndex, `Current stable release: ${versions.current}.`);
assertIncludes(llmsIndex, `${stableRawBase}/quick-start.mdx`);
-assertIncludes(
- llmsIndex,
- `${stableRawRoot}/${currentDocs.source.replace(/\/content\/docs$/, '/data/config-reference.json')}`,
-);
+assertIncludes(llmsIndex, `- [Config reference](${stableConfigReferenceUrl})`);
+assertIncludes(llmsIndex, '## Using the config reference');
+assertIncludes(llmsIndex, "jq --arg key 'ui.sidebar_width'");
+if (llmsIndex.includes(`${stableRawBase}/config-reference.mdx`)) {
+ throw new Error('llms.txt must link to config reference data instead of the unrendered MDX component');
+}
assertIncludes(llmsIndex, 'https://herdr.dev/llms-small.txt');
assertIncludes(llmsIndex, 'https://herdr.dev/llms-full.txt');
assertIncludes(llmsIndex, 'https://herdr.dev/agent-guide.md');
assertIncludes(llmsIndex, 'https://herdr.dev/llms-preview.txt');
assertIncludes(llmsPreview, `Active preview build: ${versions.preview.build_id}`);
assertIncludes(llmsPreview, `${previewRawBase}/quick-start.mdx`);
+assertIncludes(llmsPreview, `- [Config reference](${previewConfigReferenceUrl})`);
+if (llmsPreview.includes(`${previewRawBase}/config-reference.mdx`)) {
+ throw new Error('llms-preview.txt must link to config reference data instead of the unrendered MDX component');
+}
assertIncludes(llmsPreview, 'https://herdr.dev/llms.txt');
const stablePageLinks = llmsIndex
.split('\n')
- .filter((line) => line.includes(`](${stableRawBase}/`));
+ .filter(
+ (line) =>
+ line.includes(`](${stableRawBase}/`) || line.includes(`](${stableConfigReferenceUrl})`),
+ );
if (stablePageLinks.length !== versions.scopes.stable.locales.root.length) {
throw new Error(
`llms.txt lists ${stablePageLinks.length} stable pages, expected ${versions.scopes.stable.locales.root.length}`,
@@ -106,7 +118,10 @@ if (stablePageLinks.length !== versions.scopes.stable.locales.root.length) {
}
const previewPageLinks = llmsPreview
.split('\n')
- .filter((line) => line.includes(`](${previewRawBase}/`));
+ .filter(
+ (line) =>
+ line.includes(`](${previewRawBase}/`) || line.includes(`](${previewConfigReferenceUrl})`),
+ );
if (previewPageLinks.length !== versions.scopes.preview.locales.root.length) {
throw new Error(
`llms-preview.txt lists ${previewPageLinks.length} preview pages, expected ${versions.scopes.preview.locales.root.length}`,