From 31d36aa8ffc0cb848340280aeec58adcd9c43ae4 Mon Sep 17 00:00:00 2001 From: grossyoan Date: Fri, 28 Nov 2025 11:01:19 +0100 Subject: [PATCH 1/2] help-center-llms-txt --- src/_data/sidebar.yml | 6 ++-- src/_data/sidebars/help.yml | 4 +-- .../{seo.md => seo-geo.md} | 29 ++++++++++++++++--- 3 files changed, 30 insertions(+), 9 deletions(-) rename src/_help/publish-documentation/{seo.md => seo-geo.md} (64%) diff --git a/src/_data/sidebar.yml b/src/_data/sidebar.yml index fccdbca1..b03cbeab 100644 --- a/src/_data/sidebar.yml +++ b/src/_data/sidebar.yml @@ -45,8 +45,8 @@ help: label: Documentation access management link: /publish-documentation/documentation-access-management/ - type: page - label: SEO - link: /publish-documentation/seo/ + label: SEO & GEO + link: /publish-documentation/seo-geo/ - type: page label: Provide links to external resources link: /publish-documentation/external-links/ @@ -154,4 +154,4 @@ help: icon: help-circle - label: Support and SLA link: /support-and-sla/ - icon: heart-plus \ No newline at end of file + icon: heart-plus diff --git a/src/_data/sidebars/help.yml b/src/_data/sidebars/help.yml index 4416732d..eb12c81a 100644 --- a/src/_data/sidebars/help.yml +++ b/src/_data/sidebars/help.yml @@ -51,8 +51,8 @@ resources: label: Documentation access management link: /publish-documentation/documentation-access-management/ - type: page - label: SEO - link: /publish-documentation/seo/ + label: SEO & GEO + link: /publish-documentation/seo-geo/ - type: page label: Provide links to external resources link: /publish-documentation/external-links/ diff --git a/src/_help/publish-documentation/seo.md b/src/_help/publish-documentation/seo-geo.md similarity index 64% rename from src/_help/publish-documentation/seo.md rename to src/_help/publish-documentation/seo-geo.md index 50f4e8e4..e2c21b46 100644 --- a/src/_help/publish-documentation/seo.md +++ b/src/_help/publish-documentation/seo-geo.md @@ -1,15 +1,16 @@ --- -title: SEO +title: SEO & GEO --- - TOC {:toc} +## Sitemaps To optimize the indexing of your public documentation, Bump.sh automatically generates a sitemap for each one. Similarly, if you use one or more [hubs](https://docs.bump.sh/help/hubs/), they will have their own sitemap_index for all the sitemaps of the documentation they contain. -## Titles +## Meta titles The titles follow the construction below: `[Node Title] - API expanded name ([branch name])` @@ -18,7 +19,7 @@ The titles follow the construction below: - `API expanded name` uses the name of your documentation followed by `API documentation`. For example, the documentation `Bump` becomes `Bump API documentation`. - `[branch name]` is present only if there is a [branch](https://docs.bump.sh/help/publish-documentation/branching/) on the documentation. -## Description +## Meta descriptions Descriptions are limited to 160 characters and truncated beyond that. If a description is provided by `info.description` in your API definition, it will be used. @@ -27,4 +28,24 @@ Otherwise, Bump.sh automatically generates a description using the following mod ```shell This is the documentation for version #{api_version} of the API. Last update on #{l(api_definition.created_at, format: :date)} -``` \ No newline at end of file +``` + +## GEO (Generative Engine Optimization) +### llms.txt +`llms.txt` provides context for AI tools, telling crawlers what information can be retrieved behind each page of a documentation. It's available on both hubs and docs by adding `/llms.txt` at the end of the URL. + +[llms.txt of a hub](https://demo.bump.sh/llms.txt) *(example truncated for visibility purposes).* +```markdown +# Throttle Express API catalog + +## Description +## Welcome to the Bump.sh demo! + +*Bump.sh is much more than stunning documentation, for all your APIs.* + +Browse through **API Hubs** and our **sleek documentation experience**. [...] + +## APIs +- [Api: train/book](https://demo.bump.sh/doc/trainbook.md) +- [...] +```` \ No newline at end of file From 07ab5d1dbed64a7680abc7d399e29ad22a324530 Mon Sep 17 00:00:00 2001 From: grossyoan Date: Fri, 5 Dec 2025 14:45:15 +0100 Subject: [PATCH 2/2] sitemap example added and llms.txt of a doc instead of a hub --- src/_help/publish-documentation/seo-geo.md | 40 ++++++++++++++++++---- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/src/_help/publish-documentation/seo-geo.md b/src/_help/publish-documentation/seo-geo.md index e2c21b46..16b157a3 100644 --- a/src/_help/publish-documentation/seo-geo.md +++ b/src/_help/publish-documentation/seo-geo.md @@ -8,8 +8,30 @@ title: SEO & GEO ## Sitemaps To optimize the indexing of your public documentation, Bump.sh automatically generates a sitemap for each one. +[sitemap.xml of a documentation](https://bump.sh/bump-examples/doc/train-travel-api/sitemap.xml) *(example truncated for visibility purposes).* +```xml + + + https://bump.sh/bump-examples/doc/train-travel-api + 2025-10-29T15:13:09+01:00 + + + [...] +``` + Similarly, if you use one or more [hubs](https://docs.bump.sh/help/hubs/), they will have their own sitemap_index for all the sitemaps of the documentation they contain. +[sitemap_index.xml of a hub](https://demo.bump.sh/sitemap_index.xml) *(example truncated for visibility purposes).* +```xml + + + https://demo.bump.sh/doc/external-adyen/sitemap_index.xml + 2020-04-30T21:36:43+02:00 + + + [...] +``` + ## Meta titles The titles follow the construction below: @@ -34,18 +56,22 @@ Last update on #{l(api_definition.created_at, format: :date)} ### llms.txt `llms.txt` provides context for AI tools, telling crawlers what information can be retrieved behind each page of a documentation. It's available on both hubs and docs by adding `/llms.txt` at the end of the URL. -[llms.txt of a hub](https://demo.bump.sh/llms.txt) *(example truncated for visibility purposes).* +[llms.txt of a documentation](https://bump.sh/bump-examples/doc/train-travel-api/llms.txt) *(example truncated for visibility purposes).* ```markdown -# Throttle Express API catalog +# Train Travel API ## Description -## Welcome to the Bump.sh demo! +API for finding and booking train trips across Europe. + +## Servers +- Production: https://api.example.com (Production) -*Bump.sh is much more than stunning documentation, for all your APIs.* +## Topics +- [Getting started](https://bump.sh/bump-examples/doc/train-travel-api/topic/topic-getting-started.md) -Browse through **API Hubs** and our **sleek documentation experience**. [...] +## Endpoints and operations -## APIs -- [Api: train/book](https://demo.bump.sh/doc/trainbook.md) +### [Stations](https://bump.sh/bump-examples/doc/train-travel-api/group/endpoint-stations.md) +- [Get a list of train stations](https://bump.sh/bump-examples/doc/train-travel-api/operation/operation-get-stations.md) - [...] ```` \ No newline at end of file