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

[Kotlin SDK] doc update #515

Merged
merged 31 commits into from
Sep 30, 2024
Merged

[Kotlin SDK] doc update #515

merged 31 commits into from
Sep 30, 2024

Conversation

astinz
Copy link
Contributor

@astinz astinz commented Jul 21, 2024

Documentation Update

This pull request updates the documentation for Kaptos. The changes include:

  • Reflecting the current API
  • Improving word choices for better clarity
  • Updating the sample code

Copy link

vercel bot commented Jul 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
developer-docs-nextra ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 26, 2024 9:11pm

Copy link

netlify bot commented Jul 21, 2024

Deploy Preview for aptos-developer-docs ready!

Name Link
🔨 Latest commit a4c60a8
🔍 Latest deploy log https://app.netlify.com/sites/aptos-developer-docs/deploys/66b9bbf0b0d8e100086551ef
😎 Deploy Preview https://deploy-preview-515--aptos-developer-docs.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.

Copy link
Collaborator

@hariria hariria left a comment

Choose a reason for hiding this comment

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

Will let @gregnazario take a look as well

apps/nextra/pages/en/build/sdks/swift-sdk.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
apps/nextra/pages/en/build/sdks/swift-sdk/quickstart.mdx Outdated Show resolved Hide resolved
Comment on lines 38 to 66
let config = ClientConfig(
followRedirects: true,
agent: "AptosClient",
likeAgent: nil,
requestTimeout: 5000,
retryOnServerErrors: 3,
maxRetries: 5,
cache: false,
proxy: nil
)
```

### Create the `AptosSettings` object

This object is used to configure the Aptos network connection. You can set `network`,
`fullnode`, and `faucet` properties.

```swift filename="Main.swift"
let aptosSettings = AptosSettings(
network: .devnet,
fullNode: nil,
faucet: nil,
indexer: nil,
client: nil,
clientConfig: config,
fullNodeConfig: nil,
indexerConfig: nil,
faucetConfig: nil
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Fix indenting / formatting

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Expansion

Unless there’s a specific required indentation for the documentation, please share it. However, this formatting follows Xcode’s style, which is generally considered the recommended approach:

CleanShot 2024-07-23 at 11 12 10@2x

pnpm fmt

Not quite sure of the above command in the docs, but it barely does anything.

@WGB5445
Copy link
Contributor

WGB5445 commented Jul 26, 2024

Thank you very much for your contribution. Currently, we have noticed that other organizations have also contributed Swift SDKs. We want to ensure that everyone’s efforts are not overlooked, and I truly appreciate your work. We can explore the possibility of showcasing different Swift SDKs on separate pages, which would allow us to present everyone’s contributions effectively and to everyone’s satisfaction.
So could the Swift portion be merged through a separate PR?

Thank you again for your valuable contributions.

@igor-p
Copy link
Collaborator

igor-p commented Sep 17, 2024

@gregnazario @WGB5445 Are we still ok with this effort? Or do we want to split out the Swift portion and leave the rest?

@astinz
Copy link
Contributor Author

astinz commented Sep 19, 2024

Hey @igor-p,

I suggest keeping this as a subtopic under the Kotlin SDK, titled: “Kotlin SDK for iOS Developers.” . The latest deployment can serve as a ref.

@WGB5445 may continue with the native Swift SDK. This will add variety to the clients.

@gregnazario
Copy link
Collaborator

@gregnazario @WGB5445 Are we still ok with this effort? Or do we want to split out the Swift portion and leave the rest?

We can leave that section, once this PR is done, we will move it under Community SDKs

@gregnazario
Copy link
Collaborator

@astinz let's get this completed to some state that works for you, and then we're moving it under Community SDKs.

- cover single key accounts in detail
- update wording for clarification

this commit provides detailed documentation for account management with
the SDK
@astinz
Copy link
Contributor Author

astinz commented Sep 26, 2024

@gregnazario proceed, everything looks good on my end...

@gregnazario gregnazario merged commit 0a862b3 into aptos-labs:main Sep 30, 2024
3 of 4 checks passed
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.

5 participants