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

added link to docs/ and list of existing ones #301

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

himorin
Copy link
Contributor

@himorin himorin commented Sep 7, 2021

for #292, #293

Rather than having list in the top level, I've added a new README in docs/ directory. How about this?
We may be easily noticed that we have a list, and this may tell us an action to update README when adding a new directory into docs/.

docs/README.md Outdated Show resolved Hide resolved
@xfq
Copy link
Member

xfq commented Sep 7, 2021

IMHO linking directly to the documents themselves is more convenient (for the readers of the documents) than linking to these directories, i.e., we can turn line-composition/ into https://w3c.github.io/jlreq/docs/line-composition/.

Co-authored-by: Fuqiao Xue <[email protected]>
@himorin
Copy link
Contributor Author

himorin commented Sep 7, 2021

Actually, somehow thought of putting a link to github.io...
How about to have both, like [title](relative link) ([github.io](link to github.io))??

@r12a
Copy link
Contributor

r12a commented Sep 7, 2021

I prefer to have the links at the top level, not hidden and 2 steps further away. I'm not sure what problem this PR is trying to solve.

@r12a
Copy link
Contributor

r12a commented Oct 1, 2021

My suggestion would be to link from the top README page to the major documents, ie.

  • Rules for Simple Placement of Line Composition (idea) / 簡便な行組版ルール(案)
  • Design of character classes for inter-character spacing extended to Unicode / Unicode に拡張した字間プロパティの設計
  • Analysis of changes required for Adobe-Japan1 (AJ1) Japanese fonts to adopt UAX 50 / AJ!フォントをUAX 50準拠とするのに必要とされる変更点の解析

If we have miscellaneous small items that may be worth listing so that we don't forget where they are, we could add them to the directory README, and point to the directory from the top page (similar to the link you are proposing).

I think it also makes sense to point to the historical document(s) from the directory README rather than the top README (as your PR proposes). I think we don't want to make those particularly visible.

how does that sound?

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.

The change looks good. Approving.

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.

4 participants