Skip to content

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

Merged
thenswan merged 16 commits intomainfrom
1595-improve-documentation
Apr 22, 2024
Merged

Improve the documentation on how to get started with the Java SDK#1621
thenswan merged 16 commits intomainfrom
1595-improve-documentation

Conversation

@thenswan
Copy link
Contributor

@thenswan thenswan commented Oct 13, 2023 •
edited
Loading

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

@thenswan
Improve the documentation on how to get started with the Java SDK (#1595
90f935a 
)

Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan thenswan requested a review from SimiHunjan as a code owner October 13, 2023 07:34
thenswan
thenswan commented Oct 13, 2023
View reviewed changes
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

@thenswan
Implemented edits from PR comments (#1595)
4dde1cc 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
Added docs for running individual integration tests (#1595)
b2a8bd6 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
Added docs on how to run integation tests via Intellij Idea (#1595)
b0c9de5 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan thenswan linked an issue Oct 16, 2023 that may be closed by this pull request
Add the possibility to set up a Client for the localhost network through the configuration file #1622
Closed
@thenswan
Added docs on how to use configuration file to run integration tests …
a460f16 
…against the local network (#1595, #1622)

Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
Merge branch 'develop' into 1595-improve-documentation
81d6048
@thenswan
Referenced create-jar-guide.md in java-app-quickstart.md (#1595)
697dacb 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
Small improvements; fix examples docs (#1595)
787052d 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
Small fix (#1595)
bf64f1d 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@codecov
Copy link

codecov bot commented Oct 16, 2023 •
edited
Loading

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

sonarqubecloud bot commented Oct 16, 2023

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
View reviewed changes
@agadzhalov agadzhalov self-requested a review February 5, 2024 11:35
@codecov-commenter
Copy link

codecov-commenter commented Feb 6, 2024 •
edited by codecov bot
Loading

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.

@sonarqubecloud
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
View reviewed changes
@SimiHunjan SimiHunjan added this to the 2.32.0 milestone Apr 16, 2024
thenswan added 2 commits April 22, 2024 12:25
@thenswan
Merge branch 'main' into 1595-improve-documentation
2257561 
# Conflicts:
#	README.md
@thenswan
doc: highlight CONFIG_FILE description
0fa5849 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
doc: update Java SDK dependency version
f620c3d 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
thenswan added 3 commits April 22, 2024 14:51
@thenswan
doc: small improvements
de01b86 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
doc: add new example
484981e 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@thenswan
doc: commands improvement
9e084d0 
Signed-off-by: Nikita Lebedev <nikita.lebedev@limechain.tech>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 22, 2024

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

agadzhalov
agadzhalov approved these changes Apr 22, 2024
View reviewed changes
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
@thenswan thenswan deleted the 1595-improve-documentation branch April 22, 2024 13:16
@thenswan thenswan mentioned this pull request Apr 24, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agadzhalov agadzhalov agadzhalov approved these changes

@SimiHunjan SimiHunjan Awaiting requested review from SimiHunjan

@Petyo-Lukanov Petyo-Lukanov Awaiting requested review from Petyo-Lukanov

+1 more reviewer

@rokn rokn rokn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

2.32.0-beta.1

6 participants

@thenswan @codecov-commenter @rokn @agadzhalov @Petyo-Lukanov @SimiHunjan