Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ help:
link: /documentation-experience/markdown-support/
- label: Topics
link: /documentation-experience/topics/
- label: Ask AI & Markdown rendering
link: /documentation-experience/ask-ai-markdown-rendering/
- type: category
label: Customization Options
link: /customization-options/
Expand Down Expand Up @@ -154,4 +156,4 @@ help:
icon: help-circle
- label: Support and SLA
link: /support-and-sla/
icon: heart-plus
icon: heart-plus
2 changes: 2 additions & 0 deletions src/_data/sidebars/help.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ resources:
link: /documentation-experience/markdown-support/
- label: Topics
link: /documentation-experience/topics/
- label: Ask AI & Markdown rendering
link: /documentation-experience/ask-ai-markdown-rendering/
- type: category
label: Customization Options
link: /customization-options/
Expand Down
74 changes: 74 additions & 0 deletions src/_help/documentation-experience/ask-ai-markdown-rendering.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: Ask AI & Markdown rendering
---

- TOC
{:toc}

Markdown version of your API docs and hubs, optimized for AI tools, are offered next to your standard docs. These Markdown versions, by providing narrowed-down contexts, reduce token cost and hallucinations, therefore returning more relevant results.

Many API consumers now rely on AI tools to help them quickly discover API capabilities. The `Ask AI` dropdown menu offers documentation users easy access to ChatGPT and Claude, alongside a one-click Markdown access.

![ask-ai-dropdown.png](/images/help/ask-ai-dropdown.png)

## Markdown rendering
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT, could we add a section with other options ?

Screenshot when user access to Claude or ChatGPT (but private documentations are thus inaccessible), or mention that markdown can be copy-pasted, or

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the text and the screenshot about Ask AI says enough: people know what chatbots look like, and we show our selector. That's why I decided to only detail the "Markdown rendering" part, that is more specific.

I'll just add a section title, "Ask AI", at the beginning (with the existing content that is under the intro), so there's a dedicated section for Ask AI, and MD rendering.

What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, new section ## Ask AI do the job, thanks for the addition

To access the Markdown version of a documentation, add `.md` at the end of the URL (or `/source.md` if you have a custom domain, when the URL is the root of your documentation).

[On a documentation root](https://developers.bump.sh/source.md) *(example truncated for visibility purposes).*
```markdown
# Bump.sh Api

## Description
This is version `1.0` of this API documentation. Last update on Jun 16, 2025.
This is the official Bump.sh API documentation. Obviously created with Bump.sh.

The Bump.sh API is a REST API. It enables you to [...]


## Servers
- https://bump.sh/api/v1: https://bump.sh/api/v1 ()


## Endpoints
- [Branches](https://developers.bump.sh/group/endpoint-branches.md)
- [Diffs](https://developers.bump.sh/group/endpoint-diffs.md)
- [...]


## Webhooks
- [Documentation change](https://developers.bump.sh/group/webhook-documentation-change.md)
````

[For a specific operation](https://developers.bump.sh/operation/operation-post-versions.md) *(example truncated for visibility purposes).*
```markdown
# Create a new version

**POST /versions**

Deploy a new version for a given documentation, which will become the current version.


## Servers
- https://bump.sh/api/v1: https://bump.sh/api/v1 ()


## Authentication methods
- Authorization token
- Basic token


## Body parameters
Content-type: application/json
The version creation request object
- **documentation** (string)
UUID or slug of the documentation.
- [...]

## Responses
### 201: Documentation version successfully created

#### Body Parameters: application/json (object)
- **id** (string)
Unique id of your version.
- [...]
```
Binary file added src/images/help/ask-ai-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.