Skip to content

Commit 7de30d4

Browse files
committed
patch to remove source repos and optional resources from llms.txt, WIP README
1 parent 876785b commit 7de30d4

File tree

5 files changed

+219
-191
lines changed

5 files changed

+219
-191
lines changed

.ai/README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# AI Artifacts
1+
# AI Directory: LLM-related files
22

3-
This directory contains files generated for use with AI tools like coding assistants and agents in order to improve the user experience for developers using these tools
3+
The `/.ai/` directory contains files generated for use with LLM-driven tools like coding assistants and agents in order to improve the user experience for developers using these tools alongside our documentation.
44

55
## Generate Updated Files
66

@@ -12,7 +12,39 @@ Follow these steps to generate a fresh set of files after updating documentation
1212
python scripts/generate_llms.py
1313
```
1414

15-
2.
15+
2. Successful file generation will result in output similar to the following:
16+
17+
<div id="termynal" data-termynal>
18+
<span data-ty="input"><span class="file-path"></span>python3 scripts/generate_llms.py</span>
19+
<br />
20+
<span data-ty>▶️ Generate AI pages</span><br />
21+
<span data-ty>[ai-pages] processed=150 skipped=0</span><br />
22+
<span data-ty>[ai-pages] output dir: /polkadot-mkdocs/polkadot-docs/.ai/pages</span><br />
23+
<span data-ty>✅ Generate AI pages complete</span><br />
24+
<span data-ty> </span><br />
25+
<span data-ty>▶️ Generate llms.txt</span><br />
26+
<span data-ty>✅ llms.txt generated at: /polkadot-mkdocs/polkadot-docs/llms.txt</span><br />
27+
<span data-ty> Pages listed: 150</span><br />
28+
<span data-ty>✅ Generate llms.txt complete</span><br />
29+
<span data-ty> </span><br />
30+
<span data-ty>▶️ Generate site-index and full site content files</span><br />
31+
<span data-ty>✅ site-index.json written: /polkadot-mkdocs/polkadot-docs/.ai/site-index.json (pages=150)</span><br />
32+
<span data-ty>✅ llms-full.jsonl written: /polkadot-mkdocs/polkadot-docs/.ai/llms-full.jsonl (lines=1360)</span><br />
33+
<span data-ty>✅ Generate site-index and full site content files complete</span><br />
34+
<span data-ty> </span><br />
35+
<span data-ty>▶️ Generate category bundles</span><br />
36+
<span data-ty>✅ Category bundles written to: /polkadot-mkdocs/polkadot-docs/.ai/categories</span><br />
37+
<span data-ty>✅ Generate category bundles complete</span>
38+
<span data-ty> </span><br />
39+
<span data-ty>🎉 All steps finished successfully.</span>
40+
<span data-ty></span><br />
41+
</div><br /><br />
42+
43+
3. Commit the updated `/.ai/` files with your content changes and open your PR as you usually do.
44+
45+
## Guide to Scripts and Files
46+
47+
The scripts for LLM-related files generation are located in `polkadot-docs/scripts` which contains the following:
48+
49+
- **`llms_config.json`**: single point of configuration for the LLM
1650

17-
18-
##

0 commit comments

Comments
 (0)