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

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

Merged
merged 5 commits into from
Sep 6, 2022

Conversation

himorin
Copy link
Contributor

@himorin himorin commented Sep 1, 2022

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
Copy link
Contributor

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

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@himorin
Copy link
Contributor Author

himorin commented Sep 2, 2022

• 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
Copy link
Contributor

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
Copy link
Contributor Author

himorin commented Sep 2, 2022

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

@kidayasuo
Copy link
Contributor

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
Copy link
Contributor Author

himorin commented Sep 4, 2022

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
Copy link
Contributor

@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
Copy link
Contributor Author

himorin commented Sep 6, 2022

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

README.md Outdated Show resolved Hide resolved
per suggestion from @kidayasuo
per suggestion from @kidayasuo
@himorin himorin changed the title [WIP] Reorganize README to include useful links and move items to explainer Reorganize README to include useful links and move items to explainer Sep 6, 2022
@himorin
Copy link
Contributor Author

himorin commented Sep 6, 2022

ready for final review ;)

@kidayasuo
Copy link
Contributor

The changes look good. Ready to go!

Copy link
Contributor

@kidayasuo kidayasuo left a comment

Choose a reason for hiding this comment

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

👍

@himorin himorin merged commit 62b74e4 into w3c:gh-pages Sep 6, 2022
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