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

chore(javascript): update READMEs #3829

Merged
merged 9 commits into from
Sep 25, 2024
Merged

chore(javascript): update READMEs #3829

merged 9 commits into from
Sep 25, 2024

Conversation

shortcuts
Copy link
Member

@shortcuts shortcuts commented Sep 24, 2024

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-2961

Changes included:

  • update the README template to use the correct UMD path
  • point to the API documentation in each README
  • mention algoliasearch in sub clients readme

@shortcuts shortcuts self-assigned this Sep 24, 2024
@shortcuts shortcuts requested a review from a team as a code owner September 24, 2024 14:28
@algolia-bot
Copy link
Collaborator

algolia-bot commented Sep 24, 2024

✔️ Code generated!

Name Link
🪓 Triggered by 969960731fac53d64558cccb561f30cea5bf85f0
🍃 Generated commit a785a57bc68055e3283b6e085b4da16aa17fbb64
🌲 Generated branch generated/chore/javascript-readme
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 1687
go 1616
php 1404
csharp 1341
java 1117
python 1019
ruby 899
swift 757

Co-authored-by: Raed <raed.chammam@algolia.com>
@raed667 raed667 self-requested a review September 24, 2024 21:14
raed667
raed667 previously approved these changes Sep 24, 2024
@shortcuts shortcuts enabled auto-merge (squash) September 25, 2024 07:15
apiName = "lite" + Helpers.API_SUFFIX;
additionalProperties.put("apiName", apiName);
clientName = "lite" + Helpers.API_SUFFIX;
additionalProperties.put("apiName", "search");
Copy link
Collaborator

Choose a reason for hiding this comment

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

is apiName still used ?

Copy link
Member Author

Choose a reason for hiding this comment

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

yup just for the link to the doc

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

good idea !

@shortcuts shortcuts merged commit 847ce77 into main Sep 25, 2024
28 checks passed
@shortcuts shortcuts deleted the chore/javascript-readme branch September 25, 2024 09:55
algolia-bot added a commit that referenced this pull request Sep 25, 2024
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Sep 25, 2024
algolia/api-clients-automation#3829

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
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.

4 participants