Skip to content

Intro paragraph for the readthedocs API reference #2952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

miguelgrinberg
Copy link
Contributor

No description provided.

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"?

@miguelgrinberg
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants