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

Make readme improvements #1279

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Giuulob89
Copy link
Contributor

@Giuulob89 Giuulob89 commented Aug 2, 2022

We made some changes in the readme's face and put some notes to make commands more clear.

Closes issue: #1236

Co-authored-by: Murilo Gomes [email protected]

@wwahammy
Copy link
Member

wwahammy commented Aug 3, 2022

Hi @Giuulob89 thanks for the help! If this is still a work in progress, please mark the PR as draft. When it's no longer a draft, you can switch that off.

When you do want it reviewed, please also ask for my review. Thanks a ton!

@Giuulob89 Giuulob89 marked this pull request as draft August 15, 2022 14:17
@Giuulob89 Giuulob89 marked this pull request as ready for review August 15, 2022 19:08
@Giuulob89 Giuulob89 changed the title Make readme improvements (wip) Make readme improvements Aug 15, 2022
@Giuulob89
Copy link
Contributor Author

Hi, @wwahammy! The changes are ready to be reviewed now!

Copy link
Member

@wwahammy wwahammy left a comment

Choose a reason for hiding this comment

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

I like this! It gives it a nicer, more professional look!

Other than the review comment, there are a few changes that I think would help improve this:

  • Don't put the svg files inside the``appfolder. That makes them available for the application itself and we don't want that. Maybe put it underdocs/images`?
  • addicional_documentation.svg is misspelled. It should be additional_documentation.svg.
  • The Houdini logo is too big on the README. Additionally, it looks bad when in Github dark mode. I think, for now, it wouldn't hurt to just remove it.

Once, you have those, please request a new review and we should be ready to merge. Good work!

README.md Outdated
@@ -27,40 +44,42 @@ comfort and speed.

All new backend code and React components should be well tested.

## Supported operating systems
## ![Supported systems](./app/assets/images/ui_components/system_settings.svg) **Supported operating systems**
Copy link
Member

Choose a reason for hiding this comment

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

Is there anyway to not link to the SVG itself and still display it? If not, that's fine but it's kind of a weird experience when you click it. If you can avoid linking to it, please change it on all of the SVGs.

@wwahammy
Copy link
Member

Hi @Giuulob89 @murilogds, is there any update on this?

@murilogds
Copy link
Contributor

Hi @Giuulob89 @murilogds, is there any update on this?

Hi @wwahammy we've been overwhelmed with other activities these last few weeks and we haven't been able to finish it yet, we'll try to do that this week.

@murilogds murilogds force-pushed the feat/readme-improvements branch from 0f7151a to 919cd40 Compare September 15, 2022 20:00
@wwahammy
Copy link
Member

wwahammy commented Sep 27, 2022

Hi @Giuulob89 @murilogds: if this is ready to review, please make sure to request a review by pressing the little spinning arrow button next to my name in the list of reviewers (top right on the page)

@wwahammy
Copy link
Member

Hi @Giuulob89 @murilogds, just a check-in. Is this ready for review?

@wwahammy
Copy link
Member

Hi @Giuulob89 @murilogds, I wanted to check in here again. Is this ready for review?

@Giuulob89
Copy link
Contributor Author

Hi, @wwahammy ! Sorry we didn't answered earlier! This is ready to review! Thanks

Copy link
Member

@wwahammy wwahammy left a comment

Choose a reason for hiding this comment

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

Thanks for the changes all!

I noticed that the svgs are still in the app directory. Please move them over to docs/images

Also, one tiny additional change, the please change the spelling of filename of addicional_documentation.svg to additional_documentation.svg.

Thanks a ton! With these super minor changes, I think we'll be able to merge.

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.

3 participants