Skip to content

Conversation

@guimachiavelli
Copy link
Member

This is the first step in the @meilisearch/docs-team's full review of the SDK READMEs.

We have focused on improving text clarity and other minor changes. These are of course only suggestions, so please let us know what you think (and whether you want to push back on anything).

@curquiza
Copy link
Member

curquiza commented Jun 1, 2022

I think most of the changes are automatically updatable with our script! Maybe all of them 😇

@curquiza curquiza requested a review from brunoocasali June 2, 2022 11:46
alallema
alallema previously approved these changes Aug 2, 2022
Copy link
Contributor

@alallema alallema left a comment

Choose a reason for hiding this comment

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

LGTM! 🔥 🔥 🔥

Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

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

all the client.index.something should be replaced with
client.index('myIndex').something. You can name the index something else if you prefer

Copy link
Member Author

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

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

Thanks for the suggestions, @bidoubiwa—all accepted.

guimachiavelli and others added 2 commits August 2, 2022 17:39
bidoubiwa
bidoubiwa previously approved these changes Aug 2, 2022
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

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

LGTM 🔥

Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

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

🔥🔥🔥🔥🔥 LGTM 🔥🔥🔥🔥🔥

@bidoubiwa bidoubiwa changed the title README review Update README Aug 3, 2022
@bidoubiwa bidoubiwa merged commit 0365824 into meilisearch:main Aug 3, 2022
@bidoubiwa bidoubiwa added the skip-changelog The PR will not appear in the release changelogs label Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog The PR will not appear in the release changelogs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants