elastic / elastic/docs-content

[API] Style feedback

Open
#237 2 comments 0 reactions 1 assignee Claimed by @szabosteve View on GitHub
api-feedback
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

@szabosteve provided feedback from @sophiec20 about some areas for improvement in the API docs:

1. The method for showing and hiding object details. For example:
![Image](https://github.com/user-attachments/assets/d3eb0025-2551-42a0-9400-3d29e0b28cc9)
Can this be an icon or arrow instead of repeated text?

1. Nested properties and parameters. For example:
![Image](https://github.com/user-attachments/assets/4f9aaf1c-1d23-4ebb-a8e7-cca49ccba004)
Can the description be indented or the parameter/property name be bolder or bigger to make it easier to identify?

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.