SEO

• Titles
• Description

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, 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 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:

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)}