Skip to content

Clean docs against the live model catalogue for llms.txt #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lookoff-AIMLAPI merged 6 commits into from
Nov 13, 2026
Merged

Clean docs against the live model catalogue for llms.txt #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2909a22
docs: fix model ids that do not match the live catalogue
Lookoff-AIMLAPI Nov 13, 2026
c181a81
docs: remove pages of models the API no longer serves
Lookoff-AIMLAPI Nov 13, 2026
049e6ce
docs: delete OpenAPI specs that no page uses
Lookoff-AIMLAPI Nov 13, 2026
ccfa9ce
docs: re-point pages copied from another model
Lookoff-AIMLAPI Nov 13, 2026
0a42c28
ci: check docs against the live model catalogue
Lookoff-AIMLAPI Nov 13, 2026
a9903db
docs: give every model page a description with its model id
Lookoff-AIMLAPI Nov 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
29 changes: 29 additions & 0 deletions .github/workflows/check-catalogue.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Check docs against the model catalogue

# Model pages must list ids that GET /v1/models serves, and every relative link
# must resolve. Runs on docs PRs and once a day, because a model can be
# withdrawn without any change to this repo.
on:
pull_request:
paths:
- "docs/**"
- "scripts/check-catalogue.py"
- ".github/workflows/check-catalogue.yml"
schedule:
- cron: "17 6 * * *"
workflow_dispatch:

permissions:
contents: read

jobs:
check:
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Check
run: python3 scripts/check-catalogue.py
85 changes: 0 additions & 85 deletions docs/README (1).md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Learn how to get started with the AI/ML API
description: "Map of the AI/ML API docs: find the model for a task and open its API reference. One API key, OpenAI-compatible base URL https://api.aimlapi.com/v1."
icon: map
---

Expand Down
Loading
Loading