Closed nick-y-ito closed 7 months ago
@hitohata Thank you for your feedback and approval!
Do you mean something like this? In this layout, I had to delete the H1 title because it conflicts with the logo.
@hitohata
I was inspired by Radix UI's README.md
for the top part, by the way.
[ Image Area ]
<H1>
<description>
:
@hitohata
I feel the images (not an icon) should be better placed after the title section.
https://github.com/nishiki-tech/nishiki-frontend/blob/refs/heads/docs/279-refine-readmemd/README.md
As you suggested, I have restructured the intro part! This looks nicer 😄
I have added the documentation section!
Also added the backend members to the authors list!
@hitohata @kotaaaa @kanta1207
Thank you for taking the time for your reviews! I hope this README.md
will attract many visitors 😄
Overview
Refines the
README.md
as much as possible.Changes
Please see the criteria section of the linked issues.
Review points
References
I was inspired by the following repositories to refine our
README.md
.Notes
README.md
here: https://github.com/nishiki-tech/nishiki-frontend/blob/refs/heads/docs/279-refine-readmemd/README.mdAssignee Checklist:
Reviewer Checklist: