w3c / jlreq-d

Requirements for Japanese Digital Text Layout
17 stars 3 forks source link

Reorganize README to include useful links and move items to explainer #22

Closed himorin closed 2 years ago

himorin commented 2 years ago

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) leave suggested changes

kidayasuo commented 2 years ago

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"?

himorin commented 2 years ago

• 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.

Totally forgotten on that link...

• Please duplicate the explanation of the jlreq-d-resource tag in the "Related documents" section so all the resources are found under one section.

added as suggested change

• By the way what are the intended use between "Documents" and "Related documents"?

how about in suggested change added?

kidayasuo commented 2 years ago

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.

himorin commented 2 years ago

click here. note, suggested changes are just suggestion, but not merged into the PR image

kidayasuo commented 2 years ago

ah, thank you. so I need to review the changes with the diffs shown on this thread.

how about in suggested change added?

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)

himorin commented 2 years ago

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. Draft ToC or explainer should be former, but examples or collected materials could be latter...

kidayasuo commented 2 years ago

@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(このプロジェクトについて)"?

himorin commented 2 years ago

@himorin understood. thank you. then, how about making them simpler as "Documents" and "Resources" (like the gh tag suggests)?

Ah, yes. Thank you for suggestion!

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(このプロジェクトについて)"?

Wondered about that, also or just 'explainer'... For now, updated with that word.

himorin commented 2 years ago

ready for final review ;)

kidayasuo commented 2 years ago

The changes look good. Ready to go!