Skip to content

Commit

Permalink
add llms.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
zeke committed Jan 23, 2025
1 parent b7aa7c3 commit 6ee028d
Show file tree
Hide file tree
Showing 5 changed files with 1,462 additions and 1 deletion.
41 changes: 41 additions & 0 deletions .github/workflows/llm-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: LLM Docs Update

on:
workflow_dispatch: # Allows manual triggering
schedule:
- cron: '0 0 * * *' # Runs daily at midnight UTC

jobs:
update-llms:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '22'

- name: Compile llms.txt
run: npx --yes sitefetch https://cog.run -o docs/llms.txt --concurrency 10

- name: Check for changes
run: |
if git diff --quiet; then
echo "No changes to llms.txt; exiting."
exit 0
else
echo "Changes detected in llms.txt."
fi
- name: Commit and push changes
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config user.name "${{ github.actor }}"
git config user.email "${{ github.actor }}@users.noreply.github.com"
git add docs/llms.txt
git commit -m "Update llms.txt"
git push origin main
5 changes: 5 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

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

> [!TIP]
> Using a language model to help you write the code for your new Cog model?
>
> 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).
## Prerequisites

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

0 comments on commit 6ee028d

Please sign in to comment.