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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #35

Merged
merged 6 commits into from
Feb 5, 2024
Merged

Improve documentation #35

merged 6 commits into from
Feb 5, 2024

Conversation

matjazv
Copy link
Contributor

@matjazv matjazv commented Jan 31, 2024 •
edited
Loading

What was the problem?

How was it solved?

  • Various comments inside source files were updated.
  • Lisk contracts deployment diagram and smart contracts requirements documents were added to the repository

How was it tested?

N/A

@matjazv matjazv self-assigned this Jan 31, 2024
AndreasKendziorra
AndreasKendziorra requested changes Feb 1, 2024
View reviewed changes
@matjazv
Copy link
Contributor Author

matjazv commented Feb 1, 2024

@AndreasKendziorra
I've addressed all your comments.
Thank you for very good suggestions!

@matjazv matjazv requested a review from Phanco February 2, 2024 10:22
Phanco
Phanco requested changes Feb 2, 2024
View reviewed changes
Copy link
Member

@Phanco Phanco left a comment

Choose a reason for hiding this comment

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

Just some cherrypicking, others looks good 👍

@matjazv
Copy link
Contributor Author

matjazv commented Feb 2, 2024

Thank you Franco!
All comments were addressed.

@matjazv matjazv requested a review from shuse2 February 2, 2024 17:42
@shuse2 shuse2 merged commit a23f3eb into main Feb 5, 2024
3 checks passed
@shuse2 shuse2 deleted the 25-improve-code-documentation branch February 5, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shuse2 shuse2 shuse2 approved these changes

@Phanco Phanco Phanco approved these changes

@AndreasKendziorra AndreasKendziorra AndreasKendziorra approved these changes

Assignees

@matjazv matjazv

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add additional documentation Review and improve source code documentation
4 participants
@matjazv @shuse2 @Phanco @AndreasKendziorra