meilisearch-js icon indicating copy to clipboard operation
meilisearch-js copied to clipboard

Add JS hosted documentation

Open amit-ksh opened this issue 1 year ago • 1 comments

Pull Request

Related issue

Close #1240

Preview

JS docs Preview

What does this PR do?

  • Generates the documentation from code using typedoc package.
  • Use GitHub Actions to update the documentation on code push on main branch.

TODO

  • Before Merge: Remove the feat/js-docs from docs workflow.
  • After merging: Enable git pages for the repository and select deploy from gh-pages branch with root location 194395352-609d9046-3cd3-4883-b8a1-c4f22b4ed7a9

PR checklist

Please check if your PR fulfills the following requirements:

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

Thank you so much for contributing to Meilisearch!

amit-ksh avatar Jun 23 '24 15:06 amit-ksh

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.94%. Comparing base (71dcebe) to head (a9b7bfe). Report is 200 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1678   +/-   ##
=======================================
  Coverage   96.94%   96.94%           
=======================================
  Files          21       21           
  Lines         818      818           
  Branches       85       85           
=======================================
  Hits          793      793           
+ Misses         25       24    -1     
- Partials        0        1    +1     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jun 23 '24 15:06 codecov[bot]