Skip to content

Commit 0ce3e33

Browse files
juan-malbeclabsclaudegithub-actions[bot]armcconnell
authored
Improve docs UX for AI agents (llms.txt, on-domain markdown, robots, meta) (#176)
* docs: improve UX for AI agents (llms.txt, on-domain markdown, robots, meta) - Generate llms.txt and llms-full.txt from the default (English) locale via hooks/emit_markdown.py (the mkdocs-llmstxt plugin is incompatible with mkdocs-static-i18n). - Emit clean per-page Markdown as <page>/index.md for every language, served on-domain. Repoint the page toolbar's View Markdown / Copy / Ask actions at these instead of GitHub raw (which was broken for all 7 translated locales). - Add robots.txt explicitly allowing AI crawlers and referencing the sitemap. - Add site_description plus per-page descriptions so every page now has a <meta name="description"> (was none). - Fix duplicate page-toolbar.js include and the favicon typo (faviron). - Remove repo cruft (get-pip.py, "hold from setup", .DS_Store) and ignore .DS_Store / __pycache__. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * chore: auto-translate docs * docs: add per-page descriptions to remaining nav pages Every nav page now has a description: front matter, so each gets a unique <meta name="description"> and a description in llms.txt instead of falling back to the generic site_description. --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Andrew McConnell <andrew@malbeclabs.com>
1 parent 25a57eb commit 0ce3e33

66 files changed

Lines changed: 1478 additions & 27923 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.DS_Store‎

-6 KB
Binary file not shown.

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,9 @@ dist/
1717
.devcontainer/
1818
smartcontract/.vscode/settings.json
1919
site/
20+
21+
.DS_Store
22+
**/.DS_Store
23+
24+
__pycache__/
25+
**/__pycache__/

‎docs/DZ Mainnet-beta Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Connect a Solana Mainnet-Beta validator and up to three backups to DoubleZero in IBRL mode, including identity proof and the connection request.
3+
---
4+
15
# Validator Mainnet-Beta Connection in IBRL Mode
26
!!! warning "By connecting to DoubleZero I agree to the [DoubleZero Terms of Service](https://doublezero.xyz/terms-protocol)"
37

‎docs/DZ Testnet Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Connect a Solana Testnet validator to DoubleZero in IBRL mode, including the testnet evaluation agreement and connection steps.
3+
---
4+
15
# Validator Testnet Connection in IBRL Mode
26
??? warning "By connecting to DoubleZero testnet I agree to the terms of the Evaluation Agreement set forth here (click to expand)"
37
<span style="font-size:14px;">DoubleZero Testnet</span>

‎docs/Edge Subscriber Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Set up an edge subscriber to receive DoubleZero shred feeds, including client setup and firewall rules for GRE, BGP, PIM, and shred traffic.
3+
---
4+
15
# Edge Subscriber Connection
26
!!! warning "By connecting to DoubleZero I agree to the [DoubleZero Terms of Use](https://doublezero.xyz/terms-protocol). Please note that the data is for your internal purposes only and may not be retransmitted (see Section 2(e))."
37

‎docs/New Tenant.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Get in touch to bring a new distributed system or protocol onto the DoubleZero network.
3+
---
4+
15
# New Tenant
26

37
If you would like your distributed system to leverage the DoubleZero network, we’re happy to assist with any technical questions you may have.

‎docs/Other Multicast Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Connect to DoubleZero in multicast mode to publish or subscribe to one or more feeds.
3+
---
4+
15
# Other Multicast Connection
26
!!! warning "By connecting to DoubleZero I agree to the [DoubleZero Terms of Service](https://doublezero.xyz/terms-protocol)"
37

‎docs/Permissioned Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Permissioned onboarding for non-validators and RPCs connecting to DoubleZero Mainnet-Beta and Testnet in IBRL mode.
3+
---
4+
15
# Non-Validator Permissioned Connection to DoubleZero in IBRL Mode
26
!!! warning "By connecting to DoubleZero I agree to the [DoubleZero Terms of Service](https://doublezero.xyz/terms-protocol)"
37

‎docs/Shelby Permissioned Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Permissioned connection guide for Shelby Testnet users connecting to DoubleZero in IBRL mode.
3+
---
4+
15
# Connection to DoubleZero in IBRL Mode for Shelby Testnet Users
26
!!! warning "By connecting to DoubleZero I agree to the [DoubleZero Terms of Service](https://doublezero.xyz/terms-protocol)"
37

‎docs/Validator Multicast Connection.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Configure a connected validator to publish leader shreds to the DoubleZero multicast edge feed.
3+
---
4+
15
# Validator Multicast Connection
26
!!! warning "By connecting to DoubleZero I agree to the [DoubleZero Terms of Service](https://doublezero.xyz/terms-protocol)"
37

0 commit comments

Comments
 (0)