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.

Sign up for GitHub

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

Jump to bottom

Add JS SDK hosted documentation #1642

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

Add JS SDK hosted documentation #1642

wants to merge 2 commits into from

Conversation

amit-ksh
Copy link
Contributor

Pull Request

Related issue

Close #1240

What does this PR do?

  • Generates the documentation from code using typedoc package.
  • Use GitHub Actions to update the documentation on code change inside the src directory on the main branch.

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!

@codecov Codecov
Copy link

codecov bot commented Apr 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.51%. Comparing base (406b689) to head (7c72d41).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1642   +/-   ##
=======================================
  Coverage   97.51%   97.51%           
=======================================
  Files          22       22           
  Lines         846      846           
  Branches       93       86    -7     
=======================================
  Hits          825      825           
  Misses         20       20           
  Partials        1        1

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

@curquiza curquiza added the maintenance Issue about maintenance (CI, tests, refacto...) label Apr 17, 2024
curquiza
curquiza requested changes Apr 18, 2024
View reviewed changes
Copy link
Member

@curquiza curquiza left a comment

Choose a reason for hiding this comment

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

Hello @amit-ksh

Thanks a lot for this PR, definitely a good addition

Before @brunoocasali review it (he's on Holiday currently) can you add a link to the README to access the docs, let's say in this section of the README for example? 😊

@brunoocasali brunoocasali requested a review from flevi29 May 23, 2024 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@curquiza curquiza curquiza requested changes

@brunoocasali brunoocasali Awaiting requested review from brunoocasali

@flevi29 flevi29 Awaiting requested review from flevi29

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
maintenance Issue about maintenance (CI, tests, refacto...)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JavaScript hosted documentation
2 participants
@amit-ksh @curquiza