-
Notifications
You must be signed in to change notification settings - Fork 27
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: add dev docs for swift sdk #537
Conversation
@poppoerika I'm not sure how to get the Translate CI job to pass. I copied the new files to the Japanese translation section as well, but I can remove them if that's not necessary |
i18n/ja/docusaurus-plugin-content-docs/current/topics/develop/sdks/swift/cheat-sheet.mdx
Outdated
Show resolved
Hide resolved
i18n/ja/docusaurus-plugin-content-docs/current/topics/develop/sdks/swift/cheat-sheet.mdx
Outdated
Show resolved
Hide resolved
i18n/ja/docusaurus-plugin-content-docs/current/topics/develop/sdks/swift/cheat-sheet.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're not getting any syntax highlighting for the Swift code. @cprice404 is there something we need to do to enable that?
It also looks like the snippets in the API reference for publish
and subscribe
aren't showing their tabs. The topic client snippet is showing up fine, though it is also missing syntax highlighting.
The last thing I noticed was there are no snippets for the list operations, but since there are currently only Javascript snippets for those APIs anyhow, that doesn't really seem like a blocker.
you will want to check this out: public-dev-docs/docusaurus.config.js Line 371 in 8dd9c03
You may have to look in the docusaurus (or related plugin) docs to see if swift is supported, but if it is, it will almost certainly need to be added there. I haven't reviewed this PR, but if there are any other issues with the snippets showing up then there may be a few things we need to add/fix on the react components and associated plugin .ts files to make sure we've added the new language. I agree that none of these necessarily need to block this PR, fine to make incremental progress. |
Added swift to the docusaurus config list and syntax highlighting works now. The snippet issues should be fixed once this goes in (it was due to mismatch in snippet IDs): momentohq/client-sdk-swift#113 Made a ticket to add list collection type snippets in future: momentohq/client-sdk-swift#114 |
i18n/ja/docusaurus-plugin-content-docs/current/topics/develop/sdks/swift/cheat-sheet.mdx
Show resolved
Hide resolved
@cprice404 do you know how I might be able to get the Japanese translation task to pass? or possibly disable it for this PR or something? |
Swift dev docs to address momentohq/client-sdk-swift#56