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-geo.md b/src/_help/publish-documentation/seo-geo.md new file mode 100644 index 00000000..16b157a3 --- /dev/null +++ b/src/_help/publish-documentation/seo-geo.md @@ -0,0 +1,77 @@ +--- +title: SEO & GEO +--- + +- TOC +{:toc} + +## 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: + +`[Node Title] - API expanded name ([branch name])` + +- `[Node Title]` indicates which sections of the documentation the URL points to (e.g., `authentication` or `servers`). For the URL pointing to the root of your documentation, this section remains empty. +- `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. + +## 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. +Otherwise, Bump.sh automatically generates a description using the following model: + +```shell +This is the documentation for version #{api_version} of the API. +Last update on #{l(api_definition.created_at, format: :date)} +``` + +## 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 documentation](https://bump.sh/bump-examples/doc/train-travel-api/llms.txt) *(example truncated for visibility purposes).* +```markdown +# Train Travel API + +## Description +API for finding and booking train trips across Europe. + +## Servers +- Production: https://api.example.com (Production) + +## Topics +- [Getting started](https://bump.sh/bump-examples/doc/train-travel-api/topic/topic-getting-started.md) + +## Endpoints and operations + +### [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 diff --git a/src/_help/publish-documentation/seo.md b/src/_help/publish-documentation/seo.md deleted file mode 100644 index 50f4e8e4..00000000 --- a/src/_help/publish-documentation/seo.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: SEO ---- - -- TOC -{:toc} - -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 -The titles follow the construction below: - -`[Node Title] - API expanded name ([branch name])` - -- `[Node Title]` indicates which sections of the documentation the URL points to (e.g., `authentication` or `servers`). For the URL pointing to the root of your documentation, this section remains empty. -- `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 -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. -Otherwise, Bump.sh automatically generates a description using the following model: - -```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