Skip to content

Commit 05bdbea

Browse files
Oleksandr123234SergK
authored andcommitted
docs: Add llms and llms-full files to docs (#531)
1 parent ff9c570 commit 05bdbea

File tree

4 files changed

+114
-43
lines changed

4 files changed

+114
-43
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ This is particularly useful if you're hosting the documentation on GitHub pages.
7979

8080
This project is licensed under the Apache License - see the [LICENSE](LICENSE.txt) file for details.
8181

82+
## LLMs.txt
83+
84+
This repository includes an [llms.txt](https://llmstxt.org/) file at `/llms.txt`. It gives LLMs and documentation tools a structured index of the most important docs (Getting Started, Operator Guide, User Guide, upgrades, etc.).
85+
8286
## More Information
8387

8488
For more information and resources, visit the [KubeRocketCI documentation site](https://docs.kuberocketci.io).

docusaurus.config.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,20 @@ const config: Config = {
218218
},
219219
},
220220
],
221+
[
222+
'docusaurus-plugin-llms',
223+
{
224+
generateLLMsTxt: true, // the plugin generates llms.txt; manual backup is saved in llms-manual-backup.txt
225+
generateLLMsFullTxt: true,
226+
title: 'KubeRocketCI Documentation',
227+
description:
228+
'Explore KubeRocketCI Documentation for CI/CD, operator and user guides, quick start, and API. Learn how to enhance your DevOps practices with KubeRocketCI.',
229+
includeBlog: false,
230+
ignoreFiles: ['faq/**', 'api/**'], // api/ — custom CRs for operators, they bloat llms-full.txt
231+
excludeImports: true,
232+
removeDuplicateHeadings: true,
233+
},
234+
],
221235
],
222236

223237
themeConfig: {

0 commit comments

Comments
 (0)