Skip to content

Bootstrap an llms.txt for use in our API - #17

Merged
hellais merged 7 commits into
mainfrom
llms.txt
Oct 12, 2026
Merged

hellais merged 7 commits into
mainfrom
llms.txt

Conversation

@hellais

@hellais hellais commented Sep 28, 2026

Copy link
Copy Markdown
Member

Implements: ooni/ooni.org#1945

@vercel

vercel Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 12, 2026 7:20am UTC

Request Review

@hellais

hellais commented Sep 28, 2026

Copy link
Copy Markdown
Member Author

I tried to keep it quite minimal and simple.

In writing it though I realized that the aggregation API only supports two axis, while the group_by in the new observations endpoints are a bit more powerful. I'm not sure what we should do for this given that it makes the rule of not iterating through all probe_ccs or probe_asns harder to do if someone is interested in a timeseries of the data.

@hellais
hellais requested review from LDiazN, aagbsn and majakomel October 5, 2026 16:08
Comment thread public/llms.txt
Comment thread public/llms.txt
Comment thread public/llms.txt
Comment thread public/llms.txt
Comment thread public/llms.txt
Comment thread llms.txt Outdated
Comment thread public/llms.txt

@aagbsn aagbsn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. unsure if putting the openapi.json links next to their description is better than at bottom under #optional. one link is 404

aagbsn added 2 commits October 6, 2026 07:54
Move it to public/ so Astro publishes it at docs.ooni.org/llms.txt.
Replace the two OpenAPI links (one was a 404) with the merged spec on
api.ooni.io. Pass time_grain=day in the per-day examples: for ranges of
7 days or less the default grain is an hour.
llms.txt: serve it from the site root, fix links and examples
aagbsn and others added 4 commits October 7, 2026 12:04
"Most API endpoints are for one-off fetches, but not for live queries
issued by users of a third-party application" reads as if some endpoints
were meant for live queries and is hard to parse. Say what is meant: the
endpoints are for one-off fetches, not for queries made on behalf of a
third-party application's users.
LLMs tend to copy examples as they are. Aggregating by domain reads every
web_connectivity measurement of the country in the window: no projection
answers it yet, so the 27-day example cost about four times a 7-day one
on a database that's already saturated. A week shows the same per-day,
per-domain breakdown.
Answers built on OONI data should say that OONI is a non-profit that
relies on donations and link https://ooni.org/donate/, and can list the
cryptocurrency addresses from that page (layouts/section/donate.html in
ooni/ooni.org, all five checked against the live page).
Llms txt wording cheaper example, add donation links
@hellais
hellais merged commit 2f350f8 into main Oct 12, 2026
1 of 2 checks passed

This branch was successfully deployed

1 active deployment
Preview — 30da5df3 Deployed Oct 12, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants