Remove `README.md` API section, refactor Documentation section #1866

flevi29 · 2025-02-05T07:23:43Z

Pull Request

What does this PR do?

removes README.md API section
refactors Documentation section

PR checklist

Please check if your PR fulfills the following requirements:

Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
Have you read the contributing guidelines?
Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

Documentation
- Simplified the README by removing the detailed "API resources" section.
- Updated external links with UTM tracking parameters for improved analytics.
- Renamed client class references from MeiliSearch to Meilisearch in all code examples.
- Replaced the "more examples" link with references to "playgrounds" for implementation examples.
- Updated documentation links to direct users to the main Meilisearch and client library sites.

codecov · 2025-02-05T07:26:14Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.01%. Comparing base (d8d2abe) to head (838c45e).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1866   +/-   ##
=======================================
  Coverage   99.01%   99.01%           
=======================================
  Files          18       18           
  Lines        1418     1418           
  Branches      299      299           
=======================================
  Hits         1404     1404           
  Misses         14       14

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

flevi29 · 2025-05-02T10:49:25Z

@Strift We must get rid of this README.md API section. It is too much of a headache to maintain. Already have an issue regarding it: #1929

flevi29 · 2025-05-11T18:28:37Z

#1944

Strift · 2025-05-14T02:30:27Z

I agree this is causing unnecessary maintenance.

However, I think the users are mostly facing these issues because the .code-samples.meilisearch.yaml file is outdated. This is where the Meilisearch Docs retrieves the code samples from.

coderabbitai · 2025-05-19T10:29:31Z

Walkthrough

The README.md file was updated to remove the detailed "API resources" section, which previously listed TypeScript method signatures and links for Meilisearch client API operations. This section was replaced with two succinct documentation links, and the table of contents was updated to reflect this change. Additionally, UTM tracking parameters were added to all external header and "Learn more" section links. The main client class name was changed from MeiliSearch to Meilisearch in all code examples and import statements.

Changes

File(s)	Change Summary
README.md	Removed detailed "API resources" section and its TOC entry; added UTM parameters to header and "Learn more" links; renamed `MeiliSearch` to `Meilisearch` in all code examples; updated documentation links and references to "playgrounds" instead of "more examples".

Poem

In README fields where APIs grew,
Now just two links shine through.
The clutter is gone, the docs are neat,
A simpler path for all to greet.
🐇 With every hop, we clear the way,
For better docs—hip hip hooray!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3e64f6 and 838c45e.

📒 Files selected for processing (1)

README.md (10 hunks)

✅ Files skipped from review due to trivial changes (1)

README.md

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: integration-tests (Node.js 20)
GitHub Check: integration-tests (Node.js 22)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

flevi29 · 2025-05-19T12:37:45Z

I think the users are mostly facing these issues because the .code-samples.meilisearch.yaml file is outdated.

I have addressed this in #1948

flevi29 · 2025-05-19T17:12:53Z

@coderabbitai review

coderabbitai · 2025-05-19T17:12:58Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

43-47: Optional: Improve bullet styling for consistency
For consistency with other title-cased headings in the README, you could capitalize the link text and description and swap the Unicode “─” for an em-dash:

- [client library documentation](https://meilisearch.github.io/meilisearch-js/modules.html) ─ information on each exported item of this package
+ [Client library documentation](https://meilisearch.github.io/meilisearch-js/modules.html) — Information on each exported item of this package

- [main documentation website](https://www.meilisearch.com/docs/) ─ general
- information on how to use Meilisearch—such as our API reference, tutorials,
- guides, and in-depth articles
+ [Main documentation website](https://www.meilisearch.com/docs/) — General information on how to use Meilisearch, including our API reference, tutorials, guides, and in-depth articles

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 77505c0 and db16378.

📒 Files selected for processing (1)

README.md (1 hunks)

🔇 Additional comments (2)

README.md (2)

43-44: Validate client library documentation link
The new [client library documentation] link correctly points to the generated modules page and succinctly replaces the old in-README API listings.

45-47: Validate main documentation website link
The [main documentation website] link now directs users to the centralized docs site for full API references, tutorials, and guides—this is a clear and maintainable replacement for the removed API section.

flevi29 · 2025-06-05T06:52:26Z

@Strift Thanks for fix! Do you know what the conflict was? I think I'm doing something wrong on git on my end.

Strift · 2025-06-05T07:08:20Z

It was unclear to me tbh, I just rebased locally and manually fixed the conflicts 🤔

It didn't look like there were any ”real” conflicts

flevi29 added the documentation Improvements or additions to documentation label Feb 5, 2025

flevi29 mentioned this pull request Feb 5, 2025

Improve JSDoc documentation #1796

Open

8 tasks

flevi29 linked an issue May 8, 2025 that may be closed by this pull request

Property 'deleteTasks' does not exist on type 'MeiliSearch'.ts(2339) #1929

Closed

coderabbitai bot reviewed May 19, 2025

View reviewed changes

Strift approved these changes Jun 5, 2025

View reviewed changes

Strift added 4 commits June 5, 2025 14:37

Rebase and fix conflicts

0368ca2

Remove capital S in meilisearch

f2015fd

Rebase and fix conflicts

c6e5953

Update Learn more section

838c45e

Strift force-pushed the remove-readme-api-section branch from f3e64f6 to 838c45e Compare June 5, 2025 06:50

Strift enabled auto-merge June 5, 2025 06:51

Strift added this pull request to the merge queue Jun 5, 2025

Merged via the queue into meilisearch:main with commit 9339216 Jun 5, 2025
7 checks passed

flevi29 deleted the remove-readme-api-section branch June 5, 2025 06:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove `README.md` API section, refactor Documentation section #1866

Remove `README.md` API section, refactor Documentation section #1866

Uh oh!

flevi29 commented Feb 5, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

codecov bot commented Feb 5, 2025 •

edited

Loading

Uh oh!

flevi29 commented May 2, 2025 •

edited

Loading

Uh oh!

flevi29 commented May 11, 2025

Uh oh!

Strift commented May 14, 2025

Uh oh!

coderabbitai bot commented May 19, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

flevi29 commented May 19, 2025

Uh oh!

flevi29 commented May 19, 2025

Uh oh!

coderabbitai bot commented May 19, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

flevi29 commented Jun 5, 2025

Uh oh!

Uh oh!

Strift commented Jun 5, 2025

Uh oh!

Uh oh!

Remove README.md API section, refactor Documentation section #1866

Remove README.md API section, refactor Documentation section #1866

Uh oh!

Conversation

flevi29 commented Feb 5, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

What does this PR do?

PR checklist

Summary by CodeRabbit

Uh oh!

codecov bot commented Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

flevi29 commented May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flevi29 commented May 11, 2025

Uh oh!

Strift commented May 14, 2025

Uh oh!

coderabbitai bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

flevi29 commented May 19, 2025

Uh oh!

flevi29 commented May 19, 2025

Uh oh!

coderabbitai bot commented May 19, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

flevi29 commented Jun 5, 2025

Uh oh!

Uh oh!

Strift commented Jun 5, 2025

Uh oh!

Uh oh!

Remove `README.md` API section, refactor Documentation section #1866

Remove `README.md` API section, refactor Documentation section #1866

flevi29 commented Feb 5, 2025 •

edited by coderabbitai bot

Loading

codecov bot commented Feb 5, 2025 •

edited

Loading

flevi29 commented May 2, 2025 •

edited

Loading

coderabbitai bot commented May 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)