Skip to content

Add llm.txt standard file for LLM content discovery#516

Open
Copilot wants to merge 3 commits intomainfrom
copilot/add-llm-txt-standard
Open

Add llm.txt standard file for LLM content discovery#516
Copilot wants to merge 3 commits intomainfrom
copilot/add-llm-txt-standard

Conversation

Copy link
Contributor

Copilot AI commented Jan 22, 2026

Description

Implements llm.txt following the proposed website standard (analogous to robots.txt) to provide LLMs with a curated, machine-readable guide to QUL's resources.

File: /public/llm.txt (281 lines, ~11KB Markdown)

Structured sections:

  • Core Resources - Translations, Tafsirs, Languages with direct API links
  • Quran Data - Chapters (114), Verses (6,236), Word-level data, multiple script variants (Uthmani, Imlaei, Indopak)
  • Quran Audio - Surah recitations (gapless), Ayah recitations (verse-by-verse), segment data
  • Mushaf Layouts - Multiple formats, page mappings, word positioning, line alignments
  • API Endpoints - Complete v1 API reference with all endpoints documented
  • Tools - Community tools (script comparison, boundaries, SVG optimizer), Morphology tools (dependency graphs), Admin CMS
  • Documentation - FAQs, setup guides, community links

Serves automatically from /public at https://qul.tarteel.ai/llm.txt.

Related Issue

Issue requesting llm.txt implementation to improve AI-driven content discovery and search visibility.

Motivation and Context

LLMs querying QUL currently lack structured guidance on available resources. The llm.txt standard provides a centralized, high-signal map of:

  • 200+ translations and tafsirs
  • Audio resources with segment boundaries
  • Multiple Arabic script variants
  • Mushaf layout data
  • Morphological analysis tools

Improves LLM comprehension of QUL's capabilities and enables more accurate responses about Quranic data access.

How Has This Been Tested?

  • ✅ File accessibility verified via HTTP server (200 OK, correct Content-Length)
  • ✅ Markdown structure validated (proper heading hierarchy, all sections present)
  • ✅ Route consistency confirmed against config/routes.rb (API vs web route distinction clarified in morphology section)
  • ✅ No code security concerns (text file only)

Screenshots (if appropriate):

N/A - text file addition

Original prompt

This section details on the original issue you should resolve

<issue_title>Add llm.txt</issue_title>
<issue_description>llms.txt is a proposed website standard, like robots.txt, that provides a curated guide for LLMs, directing them to a site's most important content in a structured, machine-readable format (often Markdown) to improve AI understanding, generate better answers, and potentially boost visibility in AI-driven searches. It helps AI tools efficiently find key information, acting as a "cheat sheet" to highlight valuable content, differentiate from basic search engine directives, and ensure relevance in AI responses.

Sample markdown

Quranic Universal Library - Key Content Guide

Resources

  • Links to all resources

Tools

  • Links to all tools

FAQs & Help

  • [Link to Frequently Asked Questions]

Maybe we can create separate headings for each resource, e.g

Quran audio

  • Links

Quran data(Metadata, Surah, Ayah info)

  • List

Quran layout (Mushaf layouts)

  • List </issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@zeet-co
Copy link

zeet-co bot commented Jan 22, 2026

We're building your pull request over on Zeet.
Click me for more info about your build and deployment.
Once built, this branch can be tested at: https://quranic-universal-library-my2s-co-80601d.tarteel-v3.tarteel.io before merging 😉

Co-authored-by: naveed-ahmad <701567+naveed-ahmad@users.noreply.github.com>
Co-authored-by: naveed-ahmad <701567+naveed-ahmad@users.noreply.github.com>
Copilot AI changed the title [WIP] Add llm.txt as website standard for AI guidance Add llm.txt standard file for LLM content discovery Jan 22, 2026
Copilot AI requested a review from naveed-ahmad January 22, 2026 10:57
@naveed-ahmad naveed-ahmad marked this pull request as ready for review January 22, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add llm.txt

2 participants