elastic / elastic/docs-content

[API]: Add LLM instructions to our API docs and client docs

Open
#6,730 2 comments 0 reactions 0 assignees View on GitHub
api-feedback Team:Developer Team:Platform Team:Search
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 21h
Merged PRs (30d)
141

Description

### Was the documentation helpful?

Yes

### What documentation page or section is affected

All API docs I think, like:

* https://www.elastic.co/docs/api/doc/elasticsearch/
* https://www.elastic.co/docs/api/doc/kibana/

But also all clients if possible:

* https://www.elastic.co/docs/reference/elasticsearch-clients

### Description

I found [this page](https://developer.spotify.com/documentation/web-api/tutorials/building-with-ai) from Spotify this morning and found that's it's super nice.

Image

Could we add similar LLM instructions to our API docs like https://www.elastic.co/docs/api/doc/elasticsearch/ and within each specific client (https://www.elastic.co/docs/reference/elasticsearch-clients)?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.