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 hosted documentation #1678

Merged
merged 4 commits into from
Jul 24, 2024
Merged

Add JS hosted documentation #1678

merged 4 commits into from
Jul 24, 2024

Conversation

amit-ksh
Copy link
Contributor

@amit-ksh amit-ksh commented Jun 23, 2024 •
edited
Loading

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!

@codecov Codecov
Copy link

codecov bot commented Jun 23, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

@curquiza curquiza requested a review from flevi29 July 10, 2024 12:18
curquiza
curquiza approved these changes Jul 24, 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

sorry for the delay, and thank you for this PR ❤️

bors merge

@curquiza curquiza added the maintenance Issue about maintenance (CI, tests, refacto...) label Jul 24, 2024
@curquiza curquiza merged commit 3506ce2 into meilisearch:main Jul 24, 2024
6 checks passed
@curquiza curquiza mentioned this pull request Aug 20, 2024
Merged
meili-bors bot added a commit that referenced this pull request Aug 26, 2024
@meili-bors @meili-bot
Merge #1695
bb4f53e 
1695: Update version for the next release (v0.42.0) r=brunoocasali a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-js to a new version: "v0.42.0"

CHANGELOGS 👇

This version introduces features released on Meilisearch v1.10.0 🎉
Check out the changelog of [Meilisearch v1.10.0](https://github.com/meilisearch/meilisearch/releases/tag/v1.10.0) for more information on the changes.

## ⚠️ Breaking changes

* Improve errors (#1656) `@/flevi29`
More details [here](#1656 (comment))
* Changes related to Hybrid search (experimental) for the REST embedder (#1692) `@/mdubus` 
  - Removed parameters: `query`, `inputField`, `inputType`, `pathToEmbeddings` and `embeddingObject`.
  - Replaced by `request` and `response`
  - New parameter: `headers`

## 🚀 Enhancements

* Hybrid search improvements (#1692) `@/mdubus` 
  - Add `url` parameter to the OpenAI embedder
  - `dimensions` is now available as an optional parameter for `ollama` embedders.

* Add federated search parameters (#1689) `@/flevi29` 

```js
client.multiSearch({
    federation: {},
    queries: [
      {
        indexUid: 'movies',
        q: 'batman',
        limit: 5,
      },
      {
        indexUid: 'comics',
        q: 'batman',
        limit: 5,
      },
    ]
  })
```

* Add capabilities to update documents by function (#1691) `@/flevi29` 
```js
index.updateDocumentsByFunction({
    context: { ctx: 'Harry' },
    filter: 'id = 4',
    function: 'doc.comment = `Yer a wizard, ${context.ctx}!`',
  })
)
```

* Add language settings (#1693) `@/flevi29` 
```js
client.index('INDEX_NAME').updateLocalizedAttributes([
    { attributePatterns: ['jpn'], locales: ['*_ja'] },
];)
```

* Add `locale` search parameter (#1693) `@/flevi29` 
```js
client.index('INDEX_NAME').search('進撃の巨人', { locales: ['jpn'] })
```

## ⚙️ Maintenance/misc

* Add JS hosted documentation (#1678) `@/amit-ksh`



Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
@KaliforniaShell KaliforniaShell mentioned this pull request Oct 2, 2024
Merged
@flevi29 flevi29 added documentation Improvements or additions to documentation enhancement New feature or request and removed maintenance Issue about maintenance (CI, tests, refacto...) labels Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@curquiza curquiza curquiza approved these changes

@flevi29 flevi29 Awaiting requested review from flevi29

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JavaScript hosted documentation
3 participants
@amit-ksh @curquiza @flevi29