Intro paragraph for the readthedocs API reference #2952
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pquentin
reviewed
Apr 29, 2025
There was a problem hiding this comment.
Is this what we had in index.rst in the past? Not sure it works well today with the DSL module in the client.
Additionally, as discussed offline, since clients are under "Reference" in elastic.co docs, maybe we should choose another name, like "API documentation" instead or "reference documentation"?
|
It isn't exactly what we had in the past, but it is close. I have removed references to "low-level client" for example. Just checked and the original wording including the reference to low-level client made it to the new docs on elastic.co as well, so I'll think about something more up to date to say as introduction and update both sides. |
miguelgrinberg
force-pushed
the
readthedocs-intro-paragraph
branch
from
8eadab8 to
406a834
Compare
github-actions bot
pushed a commit
that referenced
this pull request
May 1, 2025
(cherry picked from commit 5b610f6)
miguelgrinberg
added a commit
that referenced
this pull request
May 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.