-
Notifications
You must be signed in to change notification settings - Fork 20
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
Initial cleanup for 1.0. #191
Initial cleanup for 1.0. #191
Conversation
Add direct link to parameter reference from README.
I strongly suggest we make these links not visible from the GitHub front page, as we don't want people navigating to those files directly, as then the markdown does not render. (Some people already mistook the un-rendered markdown source as the intended form of the spec). That can be done by putting them in a sub-folder, named e.g. Someone with admin access is probably needed to do that, as it may require pointing the GitHub Pages link to the (A better solution is to make a nicer landing page for OpenPBR, that is not the GitHub repo itself. But that would take some time to create). |
Specification -> White paper
The spec takes about 10 seconds to properly render (due to all the MathJax I assume), maybe we should mention that next to the white paper link? |
Added a copy-pastable BibTeX citation reference, which is needed if we want OpenPBR to be referenced in papers or documentation. (The form of this can be tweaked as needed, we can check how it renders in a paper for example).
|
Added in 0c69b27. |
Rewording the text on the front page in ac84bfe, as the sentence was long and hard to parse.
|
Internal doesn't seem like a faithful description of the nature of those files. Accessing them directly is only problematic on GitHub, but works fine for someone who clones the repository. |
On my side, it loads nearly instantaneously, both on Firefox/macOS, Firefox/Windows and Edge/Windows. |
Do the equations render correctly nearly instantaneously? On my system, they show up immediately, but change format as they are correctly rendered. |
After maybe a second or so, yes. |
openpbr.bib
Outdated
@@ -3,5 +3,7 @@ @techreport{OpenPBR | |||
title = {OpenPBR Surface}, | |||
institution = {Academy Software Foundation (ASWF)}, | |||
year = {2024}, | |||
month = {May}, | |||
version = {1.0}, |
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.
A note of caution to @jstone-lucasfilm for the release candidate, that we now have a third place where the version number appears.
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.
I'm not convinced a version number is needed in a citation. It can be assumed that the reference will want to refer to the latest version, which is available at the given link.
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.
Agreed that the version number is not usually included in citations, so this may not end up being an issue in practice.
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.
I'll remove it for now.
Sounds fine to me. But I can't make this change myself as it will break the GitHub pages deployment. @jstone-lucasfilm would you mind to make this change? |
@portsmouth For moving the specification to a new location, I'm happy to assist, but I'd recommend that we leave this as an improvement for after today's release candidate. |
Sure that's fine. How about we merge the other improvements in this PR, and leave that for a different PR? |
@portsmouth Sure, I'm fine for this PR to be the first in a series of improvements over the next two weeks, but then maybe the title of the PR should be more specific? :D |
OK, changed the PR title. How is this? The ASWF logo now doubles as the link back to the OpenPBR GitHub, killing two birds with one stone. (If you prefer another form of that logo, or a different size/placement, feel free to suggest). I moved the authors to the end, and took the liberty of moving @jstone-lucasfilm to that list, as that seems fairer to me considering your contribution. The BibTeX citation is updated accordingly, with the version removed.
|
Let me add the shader playground image as well... |
I think we can thank a few more people who have made significant contributions in the last months. |
Co-authored-by: Julien Guertault <9511025+virtualzavie@users.noreply.github.com> Signed-off-by: Jamie Portsmouth <jamports@mac.com>
Co-authored-by: Julien Guertault <9511025+virtualzavie@users.noreply.github.com> Signed-off-by: Jamie Portsmouth <jamports@mac.com>
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.
This looks good to me, thanks @portsmouth.
7d7c2e4
into
AcademySoftwareFoundation:main
Add direct link to parameter reference from README.