Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 0 additions & 38 deletions scripts/build-docs.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7387,44 +7387,6 @@ describe('API Errors Generation', () => {
})

describe('LLMs', () => {
test('Should output llms.txt overview', async () => {
const { tempDir, readFile } = await createTempFiles([
{
path: './docs/manifest.json',
content: JSON.stringify({
navigation: [[{ title: 'API Doc', href: '/docs/api-doc' }]],
}),
},
{
path: './docs/api-doc.mdx',
content: `---
title: API Documentation
description: Generated API docs
---

# API Documentation
`,
},
])

await build(
await createConfig({
...baseConfig,
basePath: tempDir,
validSdks: ['react'],
llms: {
overviewPath: 'llms.txt',
},
}),
)

expect(await readFile('./dist/llms.txt')).toEqual(`# Clerk

## Docs

- [API Documentation]({{SITE_URL}}/docs/api-doc)`)
})

test('Should output llms-full.txt full pages', async () => {
const { tempDir, readFile } = await createTempFiles([
{
Expand Down
17 changes: 4 additions & 13 deletions scripts/build-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ import { extractSDKsFromIfProp } from './lib/utils/extractSDKsFromIfProp'
import { scopeHrefToSDK } from './lib/utils/scopeHrefToSDK'

import { VFile } from 'vfile'
import { writeLLMs as generateLLMs, writeLLMsFull as generateLLMsFull, listOutputDocsFiles } from './lib/llms'
import { writeLLMsFull as generateLLMsFull, listOutputDocsFiles } from './lib/llms'
import { checkPartials } from './lib/plugins/checkPartials'
import { checkTypedoc } from './lib/plugins/checkTypedoc'
import { filterOtherSDKsContentOut } from './lib/plugins/filterOtherSDKsContentOut'
Expand Down Expand Up @@ -207,7 +207,6 @@ async function main() {
hideTitleDefault: false,
},
llms: {
overviewPath: '_llms/llms.txt',
fullPath: '_llms/llms-full.txt',
},
flags: {
Expand Down Expand Up @@ -1194,18 +1193,10 @@ ${yaml.stringify({

abortSignal?.throwIfAborted()

if (config.llms?.fullPath || config.llms?.overviewPath) {
if (config.llms?.fullPath) {
const outputtedDocsFiles = listOutputDocsFiles(config, store.writtenFiles, mdxFilePaths)

if (config.llms?.fullPath) {
const llmsFull = await generateLLMsFull(outputtedDocsFiles)
await writeFile(config.llms.fullPath, llmsFull)
}

if (config.llms?.overviewPath) {
const llms = await generateLLMs(outputtedDocsFiles)
await writeFile(config.llms.overviewPath, llms)
}
const llmsFull = await generateLLMsFull(outputtedDocsFiles)
await writeFile(config.llms.fullPath, llmsFull)
}

abortSignal?.throwIfAborted()
Expand Down
4 changes: 0 additions & 4 deletions scripts/check-redirects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,9 @@ const PROTECTED_ROUTES = [
'/docs/experiment-create_account_from_docs_quickstart/[experiment]',
'/docs/experiment-nextjs_quickstart_template/[experiment]',
'/docs/images/[[...slug]]',
'/docs/llms-full.txt',
'/docs/llms.txt',
'/docs/pr/[number]/[[...slug]]',
'/docs/pr/[number]/experiment-create_account_from_docs_quickstart/[experiment]',
'/docs/pr/[number]/experiment-nextjs_quickstart_template/[experiment]',
'/docs/pr/[number]/llms-full.txt',
'/docs/pr/[number]/llms.txt',
'/docs/pr/[number]/quickstart',
'/docs/pr/[number]/raw/[[...slug]]',
'/docs/quickstart',
Expand Down
2 changes: 0 additions & 2 deletions scripts/lib/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ type BuildConfigOptions = {
outputPath: string
}
llms?: {
overviewPath?: string
fullPath?: string
}
siteFlags?: {
Expand Down Expand Up @@ -176,7 +175,6 @@ export async function createConfig(config: BuildConfigOptions) {

llms: config.llms
? {
overviewPath: config.llms.overviewPath,
fullPath: config.llms.fullPath,
}
: null,
Expand Down
5 changes: 0 additions & 5 deletions scripts/lib/llms.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ export const writeLLMsFull = async (outputtedDocsFiles: OutputtedDocsFiles) => {
return outputtedDocsFiles.map((file) => file.content).join('\n')
}

export const writeLLMs = async (outputtedDocsFiles: OutputtedDocsFiles) => {
const list = outputtedDocsFiles.map((page) => `- [${page.title}](${page.url})`).join('\n')
return `# Clerk\n\n## Docs\n\n${list}`
}

export const listOutputDocsFiles = (config: BuildConfig, docs: Docs, files: { path: string }[]) => {
return files
.filter(({ path }) => !path.startsWith('~/')) // Exclude these quick redirect pages
Expand Down
Loading