diff --git a/Gemfile.lock b/Gemfile.lock index 57dc5348..051fdc95 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -125,6 +125,7 @@ GEM PLATFORMS arm64-darwin-21 arm64-darwin-22 + arm64-darwin-23 x86_64-darwin-22 x86_64-darwin-23 x86_64-linux diff --git a/org-creation.png b/org-creation.png deleted file mode 100644 index ea18a744..00000000 Binary files a/org-creation.png and /dev/null differ diff --git a/server/CleanShot 2024-02-20 at 02.11.37.png b/server/CleanShot 2024-02-20 at 02.11.37.png deleted file mode 100644 index 8d8786d8..00000000 Binary files a/server/CleanShot 2024-02-20 at 02.11.37.png and /dev/null differ diff --git a/src/_data/sidebar.yml b/src/_data/sidebar.yml index 342064f3..9a8c163d 100644 --- a/src/_data/sidebar.yml +++ b/src/_data/sidebar.yml @@ -42,6 +42,9 @@ help: - type: page label: Documentation access management link: /publish-documentation/documentation-access-management/ + - type: page + label: SEO + link: /publish-documentation/seo/ - type: category label: Enhance your documentation content link: /enhance-documentation-content/ diff --git a/src/_help/publish-documentation/seo.md b/src/_help/publish-documentation/seo.md new file mode 100644 index 00000000..50f4e8e4 --- /dev/null +++ b/src/_help/publish-documentation/seo.md @@ -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 #{api_version} of the API. +Last update on #{l(api_definition.created_at, format: :date)} +``` \ No newline at end of file