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

172 improve documentation add readme files #173

Merged
merged 23 commits into from
Dec 13, 2023

Conversation

gangov
Copy link
Collaborator

@gangov gangov commented Dec 6, 2023

No description provided.

@gangov gangov requested a review from ueco-jb December 6, 2023 08:52
@gangov gangov self-assigned this Dec 6, 2023
@gangov gangov linked an issue Dec 6, 2023 that may be closed by this pull request
Copy link
Member

@ueco-jb ueco-jb left a comment

Choose a reason for hiding this comment

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

Apply first comment in all files.

  • don't put filler stuff, why mentioning for example
**return type:**
`void`

(which is also invalid, because 1) there is no return type; 2) there is no void type)

  • fix formatting, put plain text as plain text and code as code

contracts/factory/README.md Outdated Show resolved Hide resolved
@gangov gangov marked this pull request as ready for review December 8, 2023 08:11
@gangov gangov requested a review from ueco-jb December 11, 2023 16:16
@ueco-jb ueco-jb force-pushed the 172-improve-documentation-add-readme-files branch from e734e96 to 74ea4f9 Compare December 11, 2023 20:18
@ueco-jb ueco-jb force-pushed the 172-improve-documentation-add-readme-files branch from 74ea4f9 to 53f70a3 Compare December 11, 2023 20:19
@ueco-jb
Copy link
Member

ueco-jb commented Dec 11, 2023

@gangov Please see the changes I introduced in the last commit and apply them to other readmes.

Copy link
Member

@ueco-jb ueco-jb left a comment

Choose a reason for hiding this comment

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

LGTM

Great effort. Seems like a pain in the back, but you'll see that it will ease a lot of work in the future for new people.

@ueco-jb ueco-jb merged commit d65eef7 into main Dec 13, 2023
3 checks passed
@ueco-jb ueco-jb deleted the 172-improve-documentation-add-readme-files branch December 13, 2023 10:32
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.

Improve documentation: Add ReadMe files
2 participants