Skip to content

Commit

Permalink
SEO page creation + image cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
jayk-u committed Jun 10, 2024
1 parent 7080649 commit 7250691
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file removed org-creation.png
Binary file not shown.
Binary file removed server/CleanShot 2024-02-20 at 02.11.37.png
Binary file not shown.
3 changes: 3 additions & 0 deletions src/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
30 changes: 30 additions & 0 deletions src/_help/publish-documentation/seo.md
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)}
```

0 comments on commit 7250691

Please sign in to comment.