-
Notifications
You must be signed in to change notification settings - Fork 3
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
Reorganize README to include useful links and move items to explainer #22
Conversation
Thank you Shimono-san. Comments: • Could you add a link to the explainer document in the readme? Probably as the first one in the Documents section. The title would be, how about: "About this project", "About Requirements for Japanese Digital Text Layout" or just "Motivation"? Reflect the chosen title as the first header (#) of the English/Japanese section of the explainer document. • Please duplicate the explanation of the jlreq-d-resource tag in the "Related documents" section so all the resources are found under one section. • By the way what are the intended use between "Documents" and "Related documents"? |
fix per comment from @xfq
Totally forgotten on that link...
added as suggested change
how about in suggested change added? |
a novice GitHub question: how do I look at the complete file, rather than the diff, after the recent change has been made? I can look at the file by choosing "View file" but it seems it is as of yesterday without changes you made today. |
ah, thank you. so I need to review the changes with the diffs shown on this thread.
I am not sure because I do not have a clear idea of the difference between “Documents / Contents for this document” and “The related documents”… Could you explain it for me? (it can be via the text message) |
Originally, intention was to separate between ones which have developed for jlreq-d and/or are part of jlreq-d, and "just a reference" contents. |
@himorin understood. thank you. then, how about making them simpler as "Documents" and "Resources" (like the gh tag suggests)? Regarding the title of the now explainer document, the change you suggested is the title of this project itself. How about changing it to "About this project(このプロジェクトについて)"? |
Ah, yes. Thank you for suggestion!
Wondered about that, also or just 'explainer'... For now, updated with that word. |
ready for final review ;) |
The changes look good. Ready to go! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Working draft for reorganization.
@kidayasuo please comment here, or suggested changes directly into PR (press
+
right after line number, and push button in red circle shown in image)