Skip to content

Commit b16a950

Browse files
LLM-friendly docs (llms.txt) and robots.txt (#1972)
* feat: add docusaurus-plugin-llms and robots.txt Integrate docusaurus-plugin-llms to emit llms.txt and llms-full.txt for all docs (public networks, private networks, global) with sensible include order and MDX-friendly cleaning options. Add static robots.txt (RFC 9309) with Allow rules, common AI crawlers, and Sitemap pointing at besu.hyperledger.org. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * fix: move docusaurus-plugin-llms to dependencies for CI The docs-build workflow installs production dependencies only; the LLMS plugin is required at docusaurus build time, so it must not be a devDependency. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Update docusaurus.config.js Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com> Signed-off-by: Byron Gravenorst <50852695+bgravenorst@users.noreply.github.com> --------- Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> Signed-off-by: Byron Gravenorst <50852695+bgravenorst@users.noreply.github.com> Co-authored-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com>
1 parent 2cac4fc commit b16a950

4 files changed

Lines changed: 77 additions & 2 deletions

File tree

docusaurus.config.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,26 @@ const config = {
329329
],
330330
},
331331
],
332+
[
333+
"docusaurus-plugin-llms",
334+
{
335+
docsDir: "docs",
336+
generateLLMsTxt: true,
337+
generateLLMsFullTxt: true,
338+
title: "Besu documentation",
339+
description:
340+
"Official Besu documentation: public Ethereum networks, permissioned / private networks, APIs, configuration, and operations.",
341+
excludeImports: true,
342+
removeDuplicateHeadings: true,
343+
logLevel: process.env.CI ? "quiet" : "normal",
344+
ignoreFiles: ["assets/**"],
345+
includeOrder: [
346+
"public-networks/**/*",
347+
"private-networks/**/*",
348+
"global/**/*",
349+
],
350+
},
351+
],
332352
],
333353
themes: [
334354
[

package-lock.json

Lines changed: 37 additions & 2 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
@@ -36,6 +36,7 @@
3636
"@docusaurus/theme-common": "^3.10.1",
3737
"@docusaurus/theme-mermaid": "^3.10.1",
3838
"@easyops-cn/docusaurus-search-local": "^0.55.0",
39+
"docusaurus-plugin-llms": "^0.4.0",
3940
"@mdx-js/react": "^3.0.0",
4041
"clsx": "^2.1.1",
4142
"open-ask-ai": "^0.7.3",

static/robots.txt

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# https://www.rfc-editor.org/rfc/rfc9309
2+
# Hyperledger Besu documentation — allow indexing and AI crawlers.
3+
4+
User-agent: *
5+
Allow: /
6+
7+
User-agent: GPTBot
8+
Allow: /
9+
10+
User-agent: OAI-SearchBot
11+
Allow: /
12+
13+
User-agent: PerplexityBot
14+
Allow: /
15+
16+
User-agent: Google-Extended
17+
Allow: /
18+
19+
Sitemap: https://besu.hyperledger.org/sitemap.xml

0 commit comments

Comments
 (0)