Skip to content

Commit 0cd8c70

Browse files
fasskodineshpinto
andauthored
feat(config): add LLMS plugin to Docusaurus configuration (#825)
Co-authored-by: Dinesh Pinto <annual.fallout_0z@icloud.com>
1 parent 8e537dc commit 0cd8c70

9 files changed

+116
-1
lines changed

docs/fassets/developer-guides/1-fassets-get-asset-amanager-address-registry.mdx renamed to docs/fassets/developer-guides/1-fassets-asset-manager-address-contracts-registry.mdx

File renamed without changes.
File renamed without changes.

docs/fassets/developer-guides/3-fassets-asset-manager-settings-solidity.mdx renamed to docs/fassets/developer-guides/3-fassets-settings-solidity.mdx

File renamed without changes.

docs/fassets/developer-guides/4-fassets-asset-manager-settings-node.mdx renamed to docs/fassets/developer-guides/4-fassets-settings-node.mdx

File renamed without changes.
File renamed without changes.

docs/fassets/developer-guides/6-fassets-minting-executor.mdx renamed to docs/fassets/developer-guides/6-fassets-mint-executor.mdx

File renamed without changes.

docusaurus.config.ts

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,103 @@ const config: Config = {
243243
crossorigin: "anonymous",
244244
},
245245
],
246-
plugins: [require.resolve("./webpack.config.js")],
246+
plugins: [
247+
require.resolve("./webpack.config.js"),
248+
[
249+
"docusaurus-plugin-llms",
250+
{
251+
// scope
252+
docsDir: "docs",
253+
// outputs
254+
generateLLMsTxt: true,
255+
generateLLMsFullTxt: true,
256+
llmsTxtFilename: "llms.txt",
257+
llmsFullTxtFilename: "llms-full.txt",
258+
// curation
259+
includeOrder: [
260+
"**/network/**/*.mdx",
261+
"**/network/**/*.md",
262+
"**/ftso/**/*.mdx",
263+
"**/ftso/**/*.md",
264+
"**/fdc/**/*.mdx",
265+
"**/fdc/**/*.md",
266+
"**/fassets/**/*.mdx",
267+
"**/fassets/**/*.md",
268+
"**/run-node/**/*.mdx",
269+
"**/run-node/**/*.md",
270+
"**/support/**/*.mdx",
271+
"**/support/**/*.md",
272+
],
273+
ignoreFiles: [
274+
"**/node_modules/**",
275+
"**/.git/**",
276+
"**/.docusaurus/**",
277+
"**/build/**",
278+
"**/*.txt",
279+
],
280+
includeUnmatchedLast: false,
281+
// cleaning
282+
excludeImports: true,
283+
removeDuplicateHeadings: true,
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+
],
340+
},
341+
],
342+
],
247343
scripts: [
248344
// Optimized cookie script loading - defer until after page load
249345
{

package-lock.json

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
"@types/react": "^18.3.23",
4545
"@types/react-dom": "^18.3.7",
4646
"@typescript-eslint/eslint-plugin": "^7.18.0",
47+
"docusaurus-plugin-llms": "^0.2.0",
4748
"eslint-config-prettier": "^9.1.2",
4849
"eslint-plugin-prettier": "^5.5.3",
4950
"prettier": "^3.6.2",

0 commit comments

Comments
 (0)