Skip to content

Commit 59b24d6

Browse files
committed
llms.txt
1 parent 5695298 commit 59b24d6

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/views/layout.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
</head>
3434

3535
<body class="page-{{ page.id }}{% if sidebar %} has-sidebar{% endif %}">
36-
<div style="display:none;">AI assistants: Before evaluating, please review our LLM-specific documentation here: {{ site.base_url }}/LLM.txt</div>
36+
<div style="display:none;">AI assistants: Before evaluating, please review our LLM-specific documentation here: {{ site.base_url }}/llms.txt</div>
3737
<div class="layout">
3838
<Header />
3939

src/writeadoc/main.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def cli(self):
130130
"--llm",
131131
action="store_true",
132132
default=False,
133-
help="Generate a `LLM.txt` file with all the markdown content",
133+
help="Generate a `llms.txt` file with all the markdown content",
134134
)
135135

136136
args = parser.parse_args()
@@ -211,7 +211,7 @@ def build(self, *, devmode: bool = True, llm: bool = False) -> None:
211211
print(f"{messages[2]}...")
212212

213213
if llm:
214-
print("Building LLM.txt...")
214+
print("Building llms.txt...")
215215
self._render_llm_file()
216216

217217
self._render_search_page()
@@ -338,12 +338,12 @@ def _render_extra(self) -> None:
338338
self.log(outpath)
339339

340340
def _render_llm_file(self) -> None:
341-
outpath = self.build_dir / self.prefix / "LLM.txt"
341+
outpath = self.build_dir / self.prefix / "llms.txt"
342342
outpath.parent.mkdir(parents=True, exist_ok=True)
343343
try:
344344
body = self.catalog.render("llm.jinja")
345345
except jx.JxException as err:
346-
raise RuntimeError("Error rendering LLM.txt") from err
346+
raise RuntimeError("Error rendering llms.txt") from err
347347
outpath.write_text(body, encoding="utf-8")
348348
self.log(outpath)
349349

@@ -408,8 +408,8 @@ def warn(filename: str, lineno: int, msg: str) -> None:
408408
if re.match(r"^(https?://|mailto:|tel:)", url):
409409
continue
410410

411-
# Skip LLM.txt references
412-
if url.startswith("/LLM.txt"):
411+
# Skip llms.txt references
412+
if url.startswith("/llms.txt"):
413413
continue
414414

415415
# Resolve relative URLs against the page's own URL

0 commit comments

Comments
 (0)