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

chore: update documentation #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

CharlesChien7996
Copy link
Collaborator

@CharlesChien7996 CharlesChien7996 commented Dec 11, 2024

User description

更新 SDK 串接文件


PR Type

documentation, enhancement


Description

  • Updated the main README to clarify method descriptions and usage, including changes to clientToken and clearSharedSecret.
  • Added new sections in the main README for checking device consistency and refreshing SSS backups.
  • Enhanced Android example documentation by adding clearSharedSecret and openVerifyPage methods.
  • Enhanced iOS example documentation by adding checkDevice and refreshSharedSecret methods, and updated the implementation guide for KgSDKService.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Update SDK documentation and method descriptions                 

README.md

  • Updated the description for clientToken parameter.
  • Clarified the purpose of clearSharedSecret method.
  • Modified descriptions for initParams, isReady, checkDevice, and
    goRoute methods.
  • Added new sections for device consistency check and SSS backup
    refreshing.
  • +32/-10 
    README.md
    Add new methods and update Android example documentation 

    examples/android/README.md

  • Added clearSharedSecret and openVerifyPage methods.
  • Updated method descriptions for Android example.
  • +12/-0   
    README.md
    Add new methods and update iOS example documentation         

    examples/ios/README.md

  • Added checkDevice and refreshSharedSecret methods.
  • Updated method descriptions for iOS example.
  • Added new functions to implement in KgSDKService.
  • +34/-7   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @kryptogoreviewer kryptogoreviewer bot added documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2 labels Dec 11, 2024
    @kryptogoreviewer
    Copy link

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    @kryptogoreviewer
    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant