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

docs(README): Update README structure #4675

Merged

matuzalemsteles merged 2 commits into liferay:master from sergiojimcos:clay-4671

Feb 17, 2022

Contributor

sergiojimcos commented Feb 16, 2022

What's new?
Update README.md structure including:

Table of Contents.
New Cover.
Better explanation in Setup content
Better organisation

FIXES
#4671

sergiojimcos added the comp: documentation label

sergiojimcos requested review from julien and matuzalemsteles

February 16, 2022 11:27

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

julien reviewed

View reviewed changes

Contributor

julien left a comment

@sergiojimcos pretty good changes, I left a few comments. If you need help, please let me know

sergiojimcos requested a review from julien

February 16, 2022 16:34

Member

matuzalemsteles commented Feb 16, 2022

Well, I agree with @julien's additions, seems like a good job here @sergiojimcos on better organizing the information.


          docs: Update README

6baffe4

julien force-pushed the clay-4671 branch from 82f2b55 to 6baffe4 Compare

February 17, 2022 09:27

Contributor

julien commented Feb 17, 2022

@sergiojimcos I just updated everything in 6baffe4 and squashed everything in 1 commit. Please tell me what you think when you get a chance. Thanks!

Contributor Author

sergiojimcos commented Feb 17, 2022

@sergiojimcos I just updated everything in 6baffe4 and squashed everything in 1 commit. Please tell me what you think when you get a chance. Thanks!

LGFM! To be perfectionist, I'm going to add clayui.com in the Table of Contents 😄


          docs(README): Add clayui.com to the Table of Contents

c996a7b

Contributor

julien commented Feb 17, 2022

To be perfectionist, I'm going to add clayui.com in the Table of Contents smile

Good move @sergiojimcos !

Contributor Author

sergiojimcos commented Feb 17, 2022

Hi @matuzalemsteles! README update is finished. You can review it!

matuzalemsteles approved these changes

View reviewed changes

Member

matuzalemsteles left a comment

it's much better ❤️!

matuzalemsteles merged commit 9a58206 into liferay:master

matuzalemsteles linked an issue

that may be closed by this pull request

Update Clay's README.md #4671

Closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp: documentation