Skip to content

Commit cc9118c

Browse files
committed
docs(sphinx-gp-llms): correct attribution — docs.json from Lakebed, llms community-established
why: docs.json convention originates from Lakebed, not Mintlify. Mintlify's docs.json is closer to a manifest.json (theme, nav, rendering config), not a documentation metadata object. The llms.txt and llms-full.txt conventions are community-established by now. what: - Drop Mintlify from llms-full.txt and .md twins adopter lists where Anthropic, Cloudflare, GitBook are more prominent - Clarify Mintlify's docs.json as manifest.json-like in the docs.json note (README and index.md) - Replace Mintlify with Anthropic in .md twins attribution
1 parent bb63b03 commit cc9118c

6 files changed

Lines changed: 15 additions & 13 deletions

File tree

docs/packages/sphinx-gp-llms/how-to.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ the site's content:
3737

3838
Concatenated full-content Markdown of every documentation page,
3939
following the community convention adopted by Anthropic, Cloudflare,
40-
Mintlify, and GitBook. Each page appears under a title header with
40+
and GitBook. Each page appears under a title header with
4141
a source URL, separated by `---` dividers. Source files are included
4242
as-is — MyST pages are already Markdown; RST pages are included
4343
verbatim.
@@ -57,7 +57,7 @@ machine consumption:
5757
### Per-page `.md` twins
5858

5959
Source file copies alongside each HTML page, following the
60-
"Markdown for Agents" convention (Cloudflare, Mintlify, Stripe,
60+
"Markdown for Agents" convention (Cloudflare, Stripe, Anthropic,
6161
Vercel). Every HTML page at `/path/page.html` gets a sibling at
6262
`/path/page.md` containing the original source content.
6363

docs/packages/sphinx-gp-llms/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,11 @@ fetch them in Markdown. It carries `agentEntrypoints` (pointers to
4444
per-page `markdownUrl` and `headings[]`, and the project's
4545
`sourceRepository`.
4646

47-
There is no published specification for this format. The convention
48-
originates from [Lakebed](https://docs.lakebed.dev/)
47+
There is no published specification for this format. We first noticed
48+
the convention at [Lakebed](https://docs.lakebed.dev/)
4949
(`github.com/pingdotgg/span`). Other documentation platforms also
5050
emit a file named `docs.json`, but those are typically site-builder
5151
configuration files (theme colors, navigation structure) rather than
52-
agent-oriented manifests — Mintlify's `docs.json`, for example, is a
53-
rendering configuration schema, not a content discovery format.
52+
agent-oriented manifests — Mintlify's `docs.json`, for example, is
53+
closer to a `manifest.json` that controls theme, navigation, and
54+
rendering rather than describing documentation content for agents.

packages/sphinx-gp-llms/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,14 @@ fetch them in Markdown. It carries `agentEntrypoints` (pointers to
5858
per-page `markdownUrl` and `headings[]`, and the project's
5959
`sourceRepository`.
6060

61-
There is no published specification for this format. The convention
62-
originates from [Lakebed](https://docs.lakebed.dev/)
61+
There is no published specification for this format. We first noticed
62+
the convention at [Lakebed](https://docs.lakebed.dev/)
6363
(`github.com/pingdotgg/span`). Other documentation platforms also
6464
emit a file named `docs.json`, but those are typically site-builder
6565
configuration files (theme colors, navigation structure) rather than
66-
agent-oriented manifests — Mintlify's `docs.json`, for example, is a
67-
rendering configuration schema, not a content discovery format.
66+
agent-oriented manifests — Mintlify's `docs.json`, for example, is
67+
closer to a `manifest.json` that controls theme, navigation, and
68+
rendering rather than describing documentation content for agents.
6869

6970
## See also
7071

packages/sphinx-gp-llms/src/sphinx_gp_llms/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Generates ``llms.txt``, ``llms-full.txt``, ``docs.json``, and per-page
44
``.md`` twin files during the standard HTML build, following conventions
55
established by llmstxt.org (Jeremy Howard / Answer.AI), Cloudflare
6-
("Markdown for Agents"), Mintlify, and Lakebed (Ping).
6+
("Markdown for Agents"), and Lakebed (Ping).
77
88
The extension hooks into ``build-finished`` to write output files and
99
``html-page-context`` to inject footer link variables into the template

packages/sphinx-gp-llms/src/sphinx_gp_llms/_llms_full_txt.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Generate ``llms-full.txt`` — concatenated full-content Markdown.
22
3-
Community convention adopted by Anthropic, Cloudflare, Mintlify, and
3+
Community convention adopted by Anthropic, Cloudflare, and
44
GitBook. Each page's source content is included under a title header
55
with a source URL reference, separated by ``---`` dividers.
66

packages/sphinx-gp-llms/src/sphinx_gp_llms/_md_twins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Generate per-page ``.md`` twin files alongside HTML output.
22
33
Implements the per-page Markdown endpoint convention popularized by
4-
Mintlify, Cloudflare ("Markdown for Agents"), Stripe, and Vercel.
4+
Cloudflare ("Markdown for Agents"), Stripe, Anthropic, and Vercel.
55
Each HTML page at ``/path/page.html`` gets a Markdown sibling at
66
``/path/page.md`` containing the original source content.
77

0 commit comments

Comments
 (0)