diff --git a/src/_product-updates/2025-12-8-ask-ai-markdown-rendering.md b/src/_product-updates/2025-12-8-ask-ai-markdown-rendering.md new file mode 100644 index 00000000..1316684b --- /dev/null +++ b/src/_product-updates/2025-12-8-ask-ai-markdown-rendering.md @@ -0,0 +1,121 @@ +--- +title: "Ask AI, Markdown rendering & llms.txt" +tags: [New] +image: /images/changelog/ask-ai.png +--- + +![ask-ai.png](/images/changelog/ask-ai.png) + +Many API consumers now rely on AI tools to help them quickly discover API capabilities. Conversational tools such as ChatGPT or Claude can be fed with documentation intended for humans, but that extra "human context" gives them more noise, impacting the AI tools' relevance and increasing token costs. + +Our latest release provides these tools with the right context, empowering your API doc consumers through their favorite AI tools. + +## Ask AI +Users can now easily ask questions about an API in their go-to conversational tools and get top-notch results. An "Ask AI" option has been added in documentation next to its introduction, x-topics, groups, and operations, offering access to ChatGPT and Claude with the right, narrowed-down context, alongside a one-click Markdown access. + +![Ask AI select displayed in documentation](/images/changelog/ask-ai-select.png) + +## Markdown rendering +Bump.sh now offers an alternative context optimized for AI tools through Markdown rendering. + +To access the Markdown version of a documentation, simply 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 Nov 28, 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 +- Production: https://bump.sh/api/v1 () + + +## Topics +- [Authentication](https://developers.bump.sh/authentication.md) + + +## Endpoints and operations + +### [Branches](https://developers.bump.sh/group/endpoint-branches.md) +- [Promote branch as the default one](https://developers.bump.sh/operation/operation-patch-docs-parameter-branches-parameter-set_default.md) +- [Delete a branch](https://developers.bump.sh/operation/operation-delete-docs-parameter-branches-parameter.md) +- [List available branches](https://developers.bump.sh/operation/operation-get-docs-parameter-branches.md) +- [Create a new branch](https://developers.bump.sh/operation/operation-post-docs-parameter-branches.md) +### [Diffs](https://developers.bump.sh/group/endpoint-diffs.md) +- [...] + + +## Webhooks + +### [Documentation change](https://developers.bump.sh/group/webhook-documentation-change.md) +- [Structure change](https://developers.bump.sh/operation/operation-webhookdocstructurechange.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 +- Production: https://bump.sh/api/v1 () + + +## Authentication methods +- Authorization token +- Basic token (deprecated) + + +## Parameters + +### Body: application/json (object) +The version creation request object +- **documentation** (string) + UUID or slug of the documentation. +- [...] + + +## Responses +### 201 +Documentation version successfully created + +#### Body: application/json (object) +- **id** (string) + Unique id of your version. +- [...] +``` + +## llms.txt +LLMs crawlers face similar challenges when crawling API docs: they don't know what they're looking for, and are flooded with an overabundance of information. `llms.txt` provides context, telling crawlers what information can be retrieved behind each page of a documentation. + +`llms.txt` is available on both hubs and docs, by adding `/llms.txt` at the end of the URL. + +[On a documentation](https://bump.sh/bump-examples/doc/train-travel-api/llms.txt) *(example truncated for visibility purposes).* +```markdown +# Train Travel API + +## Description +API for finding and booking train trips across Europe. + +## Servers +- Production: https://api.example.com (Production) + +## Topics +- [Getting started](https://bump.sh/bump-examples/doc/train-travel-api/topic/topic-getting-started.md) + +## Endpoints and operations + +### [Stations](https://bump.sh/bump-examples/doc/train-travel-api/group/endpoint-stations.md) +- [Get a list of train stations](https://bump.sh/bump-examples/doc/train-travel-api/operation/operation-get-stations.md) +- [...] +```` + +Don't hesitate to reach out at [hello@bump.sh](mailto:hello@bump.sh) if you have any questions/feedback. \ No newline at end of file diff --git a/src/images/changelog/ask-ai-select.png b/src/images/changelog/ask-ai-select.png new file mode 100644 index 00000000..cc5eed8e Binary files /dev/null and b/src/images/changelog/ask-ai-select.png differ diff --git a/src/images/changelog/ask-ai.png b/src/images/changelog/ask-ai.png new file mode 100644 index 00000000..66622d48 Binary files /dev/null and b/src/images/changelog/ask-ai.png differ