DOC-11959: Vector Search Code Snippets - iOS

[velicuvlad]

No description provided.

[ElliotFrancisHunter]

I'm happy with these snippets. Plenty of useful stuff for me to work with 👍🏼 As long as @pasin is happy I'll merge and add these to the docs.

[pasin]

I have just noticed this.

Should the code snippet is in the project here?

https://github.com/couchbase/docs-couchbase-lite/tree/release/3.1/modules/objc/examples

https://github.com/couchbase/docs-couchbase-lite/tree/release/3.1/modules/swift/examples

Also we have tried to make the code snippet compileable in those two XCode project. I think it's a good idea to follow that so that we don't make mistake in the code snippet.

[velicuvlad]

I know our current snippets structure, but my understanding is that Docs is looking to move away from the tags and was asked to have everything at the root of the platform directory. I have tested the snippets for interpreter and compile errors in terms of the api functionality and methods called.

To clarify, my expectations is that this won't be the final shape of the snippets, nor that the whole file to be added to the docs page quote on quote.

... will come back with another commit for some of the amends requested

[pasin]

If this is a new location, can you create an XCode project and add the file into the project? So that we don't need to manually copy the code and compile it somewhere else when we make change to the code.

[pasin]

You could aso add to the PR validation to verify the code snippet as well.

Here is an example in release/3.1 branch.
https://github.com/couchbase/docs-couchbase-lite/blob/release/3.1/.github/workflows/xcodebuild.yml

I'm asking this as in the past we made a lot of mistake in the code snippet.

You can have the structure like :

root/<codesnippet.swift>
root/xcode/<Snippet.xcodeproject>

@ElliotFrancisHunter

Can we use the existing project to keep the code snippet? I doesn't need to use the tags. The goal is to have the code within the compliable project to make sure that the code snippet can be compiled without an error. We aso have the Github PR validation to check that the code snippet is compiled. We do have the problems in the past that the code snippet had a lot of mistake and was not compilable.

[velicuvlad]

The validation automation must be done via Jenkins for multiple reasons such as access to the unreleased binaries etc. I have built the project on local and is fine.

This PR is ready for merge and can be merged if urgent until I find some time to take it with Jenkins - CBL-5561 for tracking

[ElliotFrancisHunter]

You could aso add to the PR validation to verify the code snippet as well.

Here is an example in release/3.1 branch. https://github.com/couchbase/docs-couchbase-lite/blob/release/3.1/.github/workflows/xcodebuild.yml

I'm asking this as in the past we made a lot of mistake in the code snippet.

You can have the structure like :

root/<codesnippet.swift>
root/xcode/<Snippet.xcodeproject>

@ElliotFrancisHunter

Can we use the existing project to keep the code snippet? I doesn't need to use the tags. The goal is to have the code within the compliable project to make sure that the code snippet can be compiled without an error. We aso have the Github PR validation to check that the code snippet is compiled. We do have the problems in the past that the code snippet had a lot of mistake and was not compilable.

Yes that's fine. It'll make it easier for me to implement the snippets properly rather than the rough copy paste job I've done for sake of time.

[ElliotFrancisHunter]

@pasin good to merge for sake of release 👍🏼 just waiting on your review

[pasin]

@velicuvlad I have some minor comments about the extra lines. The rest looks good to me.

[velicuvlad]

@ElliotFrancisHunter I'll merge this now