-
Notifications
You must be signed in to change notification settings - Fork 17
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
base: gh-pages
Are you sure you want to change the base?
Conversation
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 |
Co-authored-by: Fuqiao Xue <[email protected]>
Actually, somehow thought of putting a link to github.io... |
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. |
My suggestion would be to link from the top README page to the major documents, ie.
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? |
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.
The change looks good. Approving.
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/.