-
Notifications
You must be signed in to change notification settings - Fork 14
Help center: Ask AI & Markdown rendering #420
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
75 changes: 75 additions & 0 deletions
75
src/_help/documentation-experience/ask-ai-markdown-rendering.md
This file contains hidden or 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,75 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| ## Ask AI | ||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## Markdown rendering | ||
| 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. | ||
| - [...] | ||
| ``` | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, new section
## Ask AIdo the job, thanks for the addition