Skip to content
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

Refactor README and playgrounds #1836

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

flevi29
Copy link
Collaborator

@flevi29 flevi29 commented Jan 22, 2025

Pull Request

What does this PR do?

  • refactor playgrounds, so that it uses the base package.json Vite dependency, modernize it according to https://vite.new/vanilla
  • remove tons of unnecessary bloat from the README.md, keep and refactor only what matters
    • remove table of contents, GitHub already provides its own table of contents and the README is so short now that it's no longer requried
    • replace "Getting started" with "Example code" and link to the playground instead of hardcoding some examples
      • examples can easily get out of date, hard to keep track of, when kept in a README
      • many of the examples have little to do with this library, but rather present the capabilities of Meilisearch
    • remove information on ways of importing the package, it can be imported in all the standard ways possible, it is not our responsibility to inform people on how to import packages
    • remove "Learn more" section, the main documentation page link should suffice
    • remove "API resources" section, typedoc already does a way better job at documenting the API, which is linked in the "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!

@flevi29 flevi29 added the maintenance Issue about maintenance (CI, tests, refacto...) label Jan 22, 2025
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.21%. Comparing base (def691d) to head (b9b4584).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1836   +/-   ##
=======================================
  Coverage   98.21%   98.21%           
=======================================
  Files          17       17           
  Lines        1565     1565           
  Branches      333      333           
=======================================
  Hits         1537     1537           
  Misses         28       28           

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

@flevi29 flevi29 added the documentation Improvements or additions to documentation label Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Issue about maintenance (CI, tests, refacto...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant