-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
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 <code class="code-inline">#{api_version}</code> of the API. | ||
Last update on #{l(api_definition.created_at, format: :date)} | ||
``` |