Skip to content

Commit 62fb3ea

Browse files
committed
remove ai_exclude flag and tags, update README
1 parent e62910b commit 62fb3ea

File tree

6 files changed

+23
-60
lines changed

6 files changed

+23
-60
lines changed

.ai/README.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,27 @@ python scripts/generate_llms.py
1414

1515
2. Successful file generation will result in output similar to the following:
1616

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 />
17+
▶️ Generate AI pages<br />
18+
[ai-pages] processed=150 skipped=0<br />
19+
[ai-pages] output dir: /polkadot-mkdocs/polkadot-docs/.ai/pages<br />
20+
✅ Generate AI pages complete<br />
21+
<br />
22+
▶️ Generate llms.txt<br />
23+
✅ llms.txt generated at: /polkadot-mkdocs/polkadot-docs/llms.txt<br />
24+
Pages listed: 150<br />
25+
✅ Generate llms.txt complete<br />
26+
<br />
27+
▶️ Generate site-index and full site content files<br />
28+
✅ site-index.json written: /polkadot-mkdocs/polkadot-docs/.ai/site-index.json (pages=150)<br />
29+
✅ llms-full.jsonl written: /polkadot-mkdocs/polkadot-docs/.ai/llms-full.jsonl (lines=1360)<br />
30+
✅ Generate site-index and full site content files complete<br />
31+
<br />
32+
▶️ Generate category bundles<br />
33+
✅ Category bundles written to: /polkadot-mkdocs/polkadot-docs/.ai/categories<br />
34+
✅ Generate category bundles complete
35+
<br />
36+
🎉 All steps finished successfully.
37+
<br />
4238

4339
3. Commit the updated `/.ai/` files with your content changes and open your PR as you usually do.
4440

@@ -67,7 +63,7 @@ The scripts for LLM-related files generation are located in `polkadot-docs/scrip
6763

6864
### Why use the `/.ai/pages` and `/.ai/categories` directories rather than ouputting the files to '/llms-files/' like before?
6965

70-
- The Markdown files must be located in a directory that is not included in the site build to prevent Mkdocs from converting the Markdown to HTML elements when building the site.
66+
- The Markdown files are located in a directory that is not included in the site build to prevent doubling the size of the website (one HTML file + one Markdown file for every page). This arrangement also prevents the resolved Markdown being converted into HTML elements, making them less effective for LLM consumption.
7167

7268

7369

.snippets/code/get-support/generate-llms-output.html

Lines changed: 0 additions & 29 deletions
This file was deleted.

ai-chatbot-policy.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ hide:
55
- toc
66
- feedback
77
- navigation
8-
ai_exclude: true
98
---
109

1110
# AI Chatbot Policy

cookie-policy.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ hide:
55
- toc
66
- feedback
77
- navigation
8-
ai_exclude: true
98
---
109

1110
--8<-- 'https://raw.githubusercontent.com/papermoonio/polkadot-mkdocs/refs/heads/main/policies/cookie-policy.md'

scripts/llms_config.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@
4343
"terms-of-use.md",
4444
"privacy-policy.md"
4545
],
46-
"skip_paths": [".snippets", ".github", ".ai"],
47-
"frontmatter_flag": "ai_exclude"
46+
"skip_paths": [".snippets", ".github", ".ai"]
4847
}
4948
},
5049

terms-of-use.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ hide:
55
- toc
66
- feedback
77
- navigation
8-
ai_exclude: true
98
---
109

1110
--8<-- 'https://raw.githubusercontent.com/papermoonio/polkadot-mkdocs/refs/heads/main/policies/terms-of-use.md'

0 commit comments

Comments
 (0)