You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: nbs/index.qmd
+8-3Lines changed: 8 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -68,12 +68,12 @@ Note that the "Optional" section has a special meaning---if it's included, the U
68
68
69
69
llms.txt is designed to coexist with current web standards. While sitemaps list all pages for search engines,`llms.txt` offers a curated overview for LLMs. It can complement robots.txt by providing context for allowed content. The file can also reference structured data markup used on the site, helping LLMs understand how to interpret this information in context.
70
70
71
-
The approach of standardising on a path for the file follows the approach of`/robots.txt` and`/sitemap.xml`. robots.txt and`llms.txt` have different purposes---robots.txt is generally used to let automated tools what access to a site is considered acceptable, such as for search indexing bots. On the other hand,`llms.txt` information will often be used on demand when a user explicitlyrequesting information about a topic, such as when including a coding library's documentation in a project, or when asking a chat bot with searchfunctiontionality for information. Our expectation is that`llms.txt` will mainly be useful for*inference*, i.e. at the time a user is seeking assistance, as opposed to for*training*. However, perhaps if`llms.txt` usage becomes widespread, future training runs could take advantage of the information in`llms.txt` files too.
71
+
The approach of standardising on a path for the file follows the approach of`/robots.txt` and`/sitemap.xml`. robots.txt and`llms.txt` have different purposes---robots.txt is generally used to let automated toolsknowwhat access to a site is considered acceptable, such as for search indexing bots. On the other hand,`llms.txt` information will often be used on demand when a user explicitlyrequests information about a topic, such as when including a coding library's documentation in a project, or when asking a chat bot with searchfunctionality for information. Our expectation is that`llms.txt` will mainly be useful for*inference*, i.e. at the time a user is seeking assistance, as opposed to for*training*. However, perhaps if`llms.txt` usage becomes widespread, future training runs could take advantage of the information in`llms.txt` files too.
72
72
73
73
sitemap.xml is a list of all the indexable human-readable information available on a site. This isn’t a substitute for`llms.txt` since it:
74
74
75
75
- Often won’t have the LLM-readable versions of pages listed
76
-
- Doesn’t include URLs to external sites, evenalthough they might be helpful to understand the information
76
+
- Doesn’t include URLs to external sites, eventhough they might be helpful to understand the information
77
77
- Will generally cover documents that in aggregate will be too large to fit in an LLM context window, and will include a lot of information that isn’t necessary to understand the site.
78
78
79
79
##Example
@@ -104,7 +104,12 @@ Important notes:
104
104
- [Starlette full documentation](https://gist.githubusercontent.com/path/starlette-sml.md): A subset of the Starlette documentation useful for FastHTML development.
105
105
```
106
106
107
-
To create effective`llms.txt` files, consider these guidelines: Use concise, clear language. When linking to resources, include brief, informative descriptions. Avoid ambiguous terms or unexplained jargon. Run a tool that expands your`llms.txt` file into an LLM context file and test a number of language models to see if they can answer questions about your content.
107
+
To create effective`llms.txt` files, consider these guidelines:
108
+
109
+
- Use concise, clear language.
110
+
- When linking to resources, include brief, informative descriptions.
111
+
- Avoid ambiguous terms or unexplained jargon.
112
+
- Run a tool that expands your`llms.txt` file into an LLM context file and test a number of language models to see if they can answer questions about your content.