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

Add JS hosted documentation #1678

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

Conversation

amit-ksh
Copy link
Contributor

@amit-ksh amit-ksh commented Jun 23, 2024

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:

  • 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!

Copy link

codecov bot commented Jun 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.43%. Comparing base (4db319c) to head (4a33fdf).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1678   +/-   ##
=======================================
  Coverage   97.43%   97.43%           
=======================================
  Files          22       22           
  Lines         858      858           
  Branches       86       93    +7     
=======================================
  Hits          836      836           
  Misses         22       22           

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

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.

JavaScript hosted documentation
1 participant