elastic / elastic/docs-content

[META] Improve Elastic Inference documentation

Open
#5,757 0 comments 0 reactions 2 assignees Claimed by @kosabogi View on GitHub
documentation enhancement inference Team:Developer
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

## Summary

Users searching for **Elastic inference** currently land on fragmented or partial documentation that does not clearly explain core concepts or guide them through a complete workflow.

This META issue tracks the work required to create a cohesive, end-to-end documentation experience that helps users:
- understand what Elastic Inference is
- implement common use cases (semantic search, chat completion, reranking)
- optimize and troubleshoot their workflows

---

## Goals

- Provide a clear entry point for Elastic Inference
- Cover the most important use cases end-to-end
- Connect conceptual docs, tutorials, and APIs into a guided journey
- Document the inference API as the replacement for deprecated AI connectors

---

## Success criteria

- Users can go from **"What is Elastic Inference?" → "I built a working use case"** without leaving the docs ecosystem
- Core use cases (semantic search, chat completion, reranking) are fully documented end-to-end
- Clear navigation and linking between concepts, APIs, and tutorials
- Migration path from deprecated AI connectors is documented

---

## Collaboration

This effort requires coordination between:
- Docs team
- Dev team
- SMEs (inference, AI Features for connector deprecation messaging)

---

## Notes

- Replaces https://github.com/elastic/docs-content-internal/issues/119
- AI connectors (OpenAI, Bedrock, Gemini, Elastic Inference connectors) are deprecated as of stack 9.5 / serverless — elastic/docs-content-internal#1668 covers the migration path to the inference API
- Completed work: API documentation completeness review (#280), chunking section examples (#273)

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.