Skip to content

Commit 1a1853f

Browse files
authored
add llms.txt (#2120)
1 parent 7b97da5 commit 1a1853f

File tree

5 files changed

+1462
-1
lines changed

5 files changed

+1462
-1
lines changed

.github/workflows/llm-docs.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: LLM Docs Update
2+
3+
on:
4+
workflow_dispatch: # Allows manual triggering
5+
schedule:
6+
- cron: '0 0 * * *' # Runs daily at midnight UTC
7+
8+
jobs:
9+
update-llms:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v3
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v3
18+
with:
19+
node-version: '22'
20+
21+
- name: Compile llms.txt
22+
run: npx --yes sitefetch https://cog.run -o docs/llms.txt --concurrency 10
23+
24+
- name: Check for changes
25+
run: |
26+
if git diff --quiet; then
27+
echo "No changes to llms.txt; exiting."
28+
exit 0
29+
else
30+
echo "Changes detected in llms.txt."
31+
fi
32+
33+
- name: Commit and push changes
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
run: |
37+
git config user.name "${{ github.actor }}"
38+
git config user.email "${{ github.actor }}@users.noreply.github.com"
39+
git add docs/llms.txt
40+
git commit -m "Update llms.txt"
41+
git push origin main

docs/getting-started.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This guide will walk you through what you can do with Cog by using an example model.
44

5+
> [!TIP]
6+
> Using a language model to help you write the code for your new Cog model?
7+
>
8+
> Feed it [https://cog.run/llms.txt](https://cog.run/llms.txt), which has all of Cog's documentation bundled into a single file. To learn more about this format, check out [llmstxt.org](https://llmstxt.org).
9+
510
## Prerequisites
611

712
- **macOS or Linux**. Cog works on macOS and Linux, but does not currently support Windows.

0 commit comments

Comments
 (0)