docs: add code samples APIC-348 #202
Conversation
|
✔️ Deploy Preview for api-clients-automation ready! 🔨 Explore the source changes: 5542c49 🔍 Inspect the deploy log: https://app.netlify.com/sites/api-clients-automation/deploys/621f7a6e674e820007880704 😎 Browse the preview: https://deploy-preview-202--api-clients-automation.netlify.app |
millotp
changed the title
millotp
requested review from
a team,
eunjae-lee,
damcou and
shortcuts
and removed request for
a team
website/docs/introduction.mdx
Outdated
| Add the JavaScript to your `<head>` | ||
|
|
||
| ```html | ||
| <script src="https://cdn.jsdelivr.net/npm/@experimental-api-clients-automation/[email protected]/dist/algoliasearch.umd.browser.min.js"></script> |
There was a problem hiding this comment.
| <script src="https://cdn.jsdelivr.net/npm/@experimental-api-clients-automation/[email protected]/dist/algoliasearch.umd.browser.min.js"></script> | |
| <script src="https://cdn.jsdelivr.net/npm/@experimental-api-clients-automation/[email protected]/dist/algoliasearch.umd.browser.js"></script> |
There was a problem hiding this comment.
Weird that the min is bigger than the regular file
There was a problem hiding this comment.
We don't provide a min for the generate clients, the umd is the min one
There was a problem hiding this comment.
jsdelivr gave me the min url by default, but it generated the others too.
There was a problem hiding this comment.
Hm weird, I'll check but since we only provide one umd file there's no min/normal
It's fine!! and docusaurus makes it funnier too!
We could have an example for an other client like |
website/docs/introduction.mdx
Outdated
| const client = algoliasearch(appId, apiKey); | ||
|
|
||
| // And access other clients from here | ||
| const analyticsClient = algoliaClient.initAnalytics(analyticsAppId, analyticsApiKey); |
There was a problem hiding this comment.
Is there a place where we can see all the list of initXYZ methods? (It shouldn't be here, because it can be too much, but it would be nice to link to the page)
There was a problem hiding this comment.
I don't think so, and actually algoliasearch only provides analytics and personalization, (which is a weird choice IMO), should we provide more?
There was a problem hiding this comment.
@shortcuts ah okay, I didn't have the full context. So if algoliasearch only provides analytics and personalization, then how do people use other clients with algoliasearch? Is there a way? (And can you explain to me the decision? I might've missed something.)
There was a problem hiding this comment.
And can you explain to me the decision?
For now I only tried to reproduce the current usage, which only provide those two
algoliasearch/lite only provide 5 search methods to be the lightest possible
algolisearch default to the search client + allow usage of analytics and personalization
IMO we should provide all of the clients under algoliasearch and avoid touching the lite version
There was a problem hiding this comment.
then how do people use other clients with algoliasearch?
They can use the package directly, e.g. @algolia/client-abtesting
There was a problem hiding this comment.
I see! Then I guess it's okay for now to just explain here that we provide only initAnalytics and initPersonaliazation.
When we decide on changes on what to expose and what not, then we can revisit this doc.
There was a problem hiding this comment.
Is it normal that the client is named algoliaClient here ?
There was a problem hiding this comment.
Good catch, it should be client
website/docs/introduction.mdx
Outdated
|
|
||
| console.log('Search result', res.hits); | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Are we planning a live example like CodeSandbox?
There was a problem hiding this comment.
could be cool ! don't we already have that for the actual client ?
millotp
changed the title
🧭 What and Why
🎟 JIRA Ticket: APIC-348
I suck at writing doc.
There is not much code sample in this, I need to add more examples
🧪 Test
yarn website