Skip to content
This repository was archived by the owner on Dec 12, 2024. It is now read-only.

Sdk version component #1357

Merged
merged 70 commits into from
Apr 3, 2024
Merged

Sdk version component #1357

merged 70 commits into from
Apr 3, 2024

Conversation

dayhaysoos
Copy link
Contributor

This PR introduces a new component for surfacing dependencies in documentation. The goal is to be adaptive to the multiple language SDKs we provide while also correctly referring to the correct version. Only step left is adding how to use it in the contributing doc

Copy link

netlify bot commented Mar 26, 2024

Deploy Preview for tbd-website-developer ready!

Name Link
🔨 Latest commit 72e1b89
🔍 Latest deploy log https://app.netlify.com/sites/tbd-website-developer/deploys/660d82f1d406530008f02554
😎 Deploy Preview https://deploy-preview-1357--tbd-website-developer.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

const { SDK_VERSIONS } = customFields;

if (display === 'command') {
if (language === 'javascript') {
Copy link
Member

Choose a reason for hiding this comment

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

should this be a switch statement?


const { SDK_VERSIONS } = customFields;

if (display === 'command') {
Copy link
Member

Choose a reason for hiding this comment

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

should this be a switch statement?

Copy link
Member

Choose a reason for hiding this comment

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

alternatively: document other possible values for display

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From the feedback I got from dev rel, might make sense to rename to "install"

switch (language) {
case 'javascript':
Dependency = <PackageJson sdkVersions={SDK_VERSIONS} dependencies={dependencies} />;
break;
Copy link
Member

Choose a reason for hiding this comment

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

add kotlin (maven + gradle)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think so far the only language we need this for is javascript, going to follow up with Dev Rel on this

Copy link
Member

Choose a reason for hiding this comment

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

can we rename these components so there's a clear indicator in how they differ? From a glance, I can't tell what Dependencies does vs Dependency. I'd need to read the code each time I want to grab this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you think about the name <TabbedDependencies />?

@dayhaysoos dayhaysoos merged commit f02e07e into main Apr 3, 2024
13 checks passed
@dayhaysoos dayhaysoos deleted the sdk-version-component branch April 3, 2024 16:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants