elastic / elastic/docs-content
Improve Highlighting documentation structure and language clarity
- Dominant language
- No language data
- Stars
- 47
- Forks
- 261
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 141
Description
This is a follow-up issue for https://github.com/elastic/docs-content/issues/2273.
Based on recent [PR](https://github.com/elastic/elasticsearch/pull/134439) feedback, there are several opportunities to improve the [Highlighting documentation](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting) for better readability and scannability:
- Review and clean up the overall language for clarity and consistency.
- Assess if the existing notes and warnings could be better integrated into the content or moved under more specific subheadings.
- In the "How the unified highlighter works" section, consider adding more subheadings to improve scannability.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.