Skip to content

Commit 9ccc11f

Browse files
committed
fix(llms-txt): ordering and retrieval improvements
1 parent 1e5d32c commit 9ccc11f

File tree

1 file changed

+73
-7
lines changed

1 file changed

+73
-7
lines changed

docusaurus.config.ts

Lines changed: 73 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,15 @@ const config: Config = {
248248
[
249249
"docusaurus-plugin-llms",
250250
{
251-
ignoreFiles: ["**/node_modules/**", "**/.git/**", "**/*.txt"],
251+
// scope
252+
docsDir: "docs",
253+
// outputs
254+
generateLLMsTxt: true,
255+
generateLLMsFullTxt: true,
256+
llmsTxtFilename: "llms.txt",
257+
llmsFullTxtFilename: "llms-full.txt",
258+
// curation
252259
includeOrder: [
253-
"**/*.mdx",
254-
"**/*.md",
255260
"**/network/**/*.mdx",
256261
"**/network/**/*.md",
257262
"**/ftso/**/*.mdx",
@@ -265,12 +270,73 @@ const config: Config = {
265270
"**/support/**/*.mdx",
266271
"**/support/**/*.md",
267272
],
268-
// Content cleaning options for better LLM consumption
273+
ignoreFiles: [
274+
"**/node_modules/**",
275+
"**/.git/**",
276+
"**/.docusaurus/**",
277+
"**/build/**",
278+
"**/*.txt",
279+
],
280+
includeUnmatchedLast: false,
281+
// cleaning
269282
excludeImports: true,
270283
removeDuplicateHeadings: true,
271-
pathTransformation: {
272-
ignorePaths: ["docs", "1-intro"],
273-
},
284+
// consolidate bundles for better retrieval
285+
// no file larger than 250k tokens
286+
customLLMFiles: [
287+
{
288+
filename: "llms-network.txt",
289+
includePatterns: ["**/network/**/*.mdx", "**/network/**/*.md"],
290+
fullContent: true,
291+
title: "Network Documentation",
292+
description:
293+
"Flare Network concepts, integration guides, SDKs, and API/Solidity references",
294+
},
295+
{
296+
filename: "llms-ftso.txt",
297+
includePatterns: ["**/ftso/**/*.mdx", "**/ftso/**/*.md"],
298+
fullContent: true,
299+
title: "FTSO Documentation",
300+
description:
301+
"Flare Time Series Oracle (FTSO) concepts, integration guides, and API/Solidity references",
302+
},
303+
{
304+
filename: "llms-fdc.txt",
305+
includePatterns: ["**/fdc/**/*.mdx", "**/fdc/**/*.md"],
306+
fullContent: true,
307+
title: "FDC Documentation",
308+
description:
309+
"Flare Data Connector (FDC) concepts, integration guides, and API/Solidity references",
310+
},
311+
{
312+
filename: "llms-fassets.txt",
313+
includePatterns: ["**/fassets/**/*.mdx", "**/fassets/**/*.md"],
314+
fullContent: true,
315+
title: "FAssets Documentation",
316+
description:
317+
"FAssets concepts, integration guides, and API/Solidity references",
318+
},
319+
{
320+
filename: "llms-node-operators.txt",
321+
includePatterns: ["**/run-node/**/*.mdx", "**/run-node/**/*.md"],
322+
fullContent: true,
323+
title: "Flare Node Documentation",
324+
description: "Runbooks and guides for Flare node operators",
325+
},
326+
{
327+
filename: "llms-reference.txt",
328+
includePatterns: [
329+
"**/solidity-reference/**/*.mdx",
330+
"**/solidity-reference/**/*.md",
331+
"**/reference/**/*.mdx",
332+
"**/reference/**/*.md",
333+
],
334+
fullContent: true,
335+
title: "API and Solidity Reference (All Modules)",
336+
description:
337+
"Consolidated interfaces and API references across Network, FTSO, FDC and FAssets.",
338+
},
339+
],
274340
},
275341
],
276342
],

0 commit comments

Comments
 (0)