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

Improve the documentation on how to get started with the Java SDK #1621

Merged
merged 16 commits into from
Apr 22, 2024

Conversation

thenswan
Copy link
Contributor

@thenswan thenswan commented Oct 13, 2023

Description:
Improve the documentation on how to get started with the Java SDK:

  • improves documentation structure;
  • simplifies the documentation;
  • adds documentation based on user issues;

This PR also fixes the documentation:

  • min Android SDK level;
  • running SDK integration tests;
  • etc.

Related issue(s):
Fixes #1595 #1622

Copy link
Contributor Author

@thenswan thenswan left a comment

Choose a reason for hiding this comment

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

My questions for review

example-android/README.md Outdated Show resolved Hide resolved
docs/java-app/java-app-quickstart.md Show resolved Hide resolved
docs/android-app/android-app-quickstart.md Show resolved Hide resolved
docs/sdk/developer-guide.md Show resolved Hide resolved
docs/java-app/create-jar-guide.md Show resolved Hide resolved
example-android/README.md Show resolved Hide resolved
docs/sdk/developer-guide.md Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (bf54aa5) 82.20% compared to head (bf64f1d) 82.23%.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop    #1621      +/-   ##
=============================================
+ Coverage      82.20%   82.23%   +0.02%     
- Complexity      3587     3589       +2     
=============================================
  Files            186      186              
  Lines          11697    11697              
  Branches        1148     1148              
=============================================
+ Hits            9616     9619       +3     
+ Misses          1603     1602       -1     
+ Partials         478      476       -2     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Petyo-Lukanov
Petyo-Lukanov previously approved these changes Oct 18, 2023
@agadzhalov agadzhalov self-requested a review February 5, 2024 11:35
@codecov-commenter
Copy link

codecov-commenter commented Feb 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.23%. Comparing base (b86ee46) to head (bf64f1d).
Report is 16 commits behind head on main.

❗ Current head bf64f1d differs from pull request most recent head 9e084d0. Consider uploading reports for the commit 9e084d0 to get more accurate results

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1621      +/-   ##
============================================
+ Coverage     82.20%   82.23%   +0.03%     
- Complexity     3588     3589       +1     
============================================
  Files           186      186              
  Lines         11697    11697              
  Branches       1150     1148       -2     
============================================
+ Hits           9615     9619       +4     
+ Misses         1604     1602       -2     
+ Partials        478      476       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

sonarqubecloud bot commented Feb 6, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

agadzhalov
agadzhalov previously approved these changes Feb 6, 2024
docs/sdk/developer-guide.md Outdated Show resolved Hide resolved
Signed-off-by: Nikita Lebedev <[email protected]>
Signed-off-by: Nikita Lebedev <[email protected]>
Signed-off-by: Nikita Lebedev <[email protected]>
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Contributor

@agadzhalov agadzhalov left a comment

Choose a reason for hiding this comment

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

LGTM

@thenswan thenswan merged commit da51111 into main Apr 22, 2024
7 checks passed
@thenswan thenswan deleted the 1595-improve-documentation branch April 22, 2024 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
6 participants