Skip to content

AI discoverability: llms.txt, AGENTS.md, robots.txt, markdown endpoints (and related solo work) #304

Description

@Reccetech

Context

Developers increasingly reach Solo through an AI assistant rather than by browsing docs — either a human asks Claude/Cursor/Copilot for help ("deploy a local Hedera network"), or an agent fetches docs mid-task. Whether that goes well depends on how discoverable and unambiguous Solo is to a machine reader.

solo.hiero.org currently has none of the AI-discoverability baseline that leading developer-docs sites ship (Stripe-style llms.txt, per-page raw Markdown, AI-crawler robots.txt signal, repo-level AGENTS.md). This issue tracks the concrete work to close that gap.

Goal: land the high-priority AI discoverability improvements for Solo, mostly in this repo, with two related items that land in hiero-ledger/solo tracked here for visibility.

Scope (priority order)

In this repo (hiero-ledger/solo-docs)

1. llms.txt + llms-full.txt + .well-known redirect

  • Hand-authored /llms.txt (install, one-shot deploy, endpoints, credentials path, key docs, X-Instructions for known hallucination corrections)

  • Build-time /llms-full.txt via Hugo custom output format (all pages concatenated as Markdown)

  • Netlify rewrite so /.well-known/llms.txt serves the same content as /llms.txt

  • Ship Initiative 1

2. AGENTS.md at repo root

  • Cross-vendor orientation file for AI coding assistants editing this repo (Cursor, Copilot, Gemini CLI, etc.)

  • Note: hiero-ledger/solo already has AGENTS.md; solo-docs does not

  • Ship Initiative 3 (AGENTS.md)

3. AI crawler robots.txt

  • Override Hugo's default robots output with a modern Content-Signal: ai-train=yes, search=yes, ai-input=yes directive (same pattern docs.hedera.com already uses)

  • Ship Initiative 4 (robots.txt)

4. Per-page raw Markdown endpoints

  • Hugo output format so each page is also available as .md (e.g. /docs/.../quickstart.md)

  • <link rel="alternate" type="text/markdown"> so agents can discover the Markdown variant

  • Ship Initiative 5 (raw Markdown endpoints)

Related work in hiero-ledger/solo (tracked here for visibility; PRs land there)

5. GitHub README + npm package discoverability

  • Top-of-README description that names Hiero/Hedera + Kubernetes

  • Copy-pasteable Quick Start (install + one-shot deploy)

  • Pointer to live docs / llms.txt

  • package.json keywords / description alignment for npm discovery

  • Ship in hiero-ledger/solo (Initiative 2 / strategy "Initiative 7")

6. CLI Command Reference format improvement

  • Already done in solo-docs: the CLI reference page exists and is auto-synced every build from solo's release archive (solo-docs-content.tar.gz via scripts/fetch-solo-docs-content.mjs)

  • Remaining gap is in solo: the generator still emits raw --help text dumps into code blocks, not scannable command/flag/description tables

  • No solo-docs PR needed for creation; file/implement the format change in hiero-ledger/solo

  • File follow-up issue / PR in hiero-ledger/solo for structured CLI-doc tables

Out of scope (this issue)

Lower-priority strategy items not in this batch: terminology consistency audit, /index.json, Schema.org JSON-LD, "Using Solo with AI Assistants" guide, Mirror Node OpenAPI surfacing.

Notes

Work is sequenced by priority above. Initiative 1 is intended as the first PR against this issue.

Metadata

Metadata

Assignees

Labels

ImprovementDocumentation Improvement Request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions