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.

Sign up for GitHub

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

Jump to bottom

Updated documentation of reflection probes #1468

Merged
merged 5 commits into from Sep 9, 2020
Merged

Updated documentation of reflection probes #1468

merged 5 commits into from Sep 9, 2020

Conversation

fredericv-unity3d
Copy link
Contributor

Purpose of this PR

Added documentation for reflection probes

Testing status

Only documentation were added

Comments to reviewers

JordanL8
JordanL8 suggested changes Jul 31, 2020
View reviewed changes
Copy link
Contributor

@JordanL8 JordanL8 left a comment

Choose a reason for hiding this comment

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

Added a fair few suggestions; I probably should have edited to file directly but wanted to make sure I did not change the meaning too much (sorry!). Could you also change the images from svg to png?

@fredericv-unity3d
Copy link
Contributor Author

Thanks for the comments they were useful!

Considering image format, I way prefer to keep svg because:

  • It is supported in markdown and Github does display it appropriately
  • If we need to edit the image, we can just open the SVG file to edit the shapes. Which is not possible for PNG files. (you need to store the source somewhere)

@sebastienlagarde
Copy link
Collaborator

regarding the comment on svg vs png, can you run test package and doc tool on the PR?
Just want to be sure that svg is allowed. We have get many problem in the past with anything not being a png (i.e yamato validation or publishing failure). Thanks

@sebastienlagarde
Copy link
Collaborator

instruction from lewis:

f you install the doc tools package in your project, you can build the docs locally. Let me find the package name and version for you
14:14
"com.unity.package-manager-doctools": "1.2.1-preview.1",
and you need
"registry": "https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-candidates"
after your dependencies in the manifest

hen you just open the package manager and click Generate Documentation on your local package

@JordanL8
Copy link
Contributor

JordanL8 commented Sep 9, 2020

SVG is fine in the main manual, just not sure about packages. If it works fine, then keep them in!

@sebastienlagarde sebastienlagarde marked this pull request as ready for review September 9, 2020 19:19
@sebastienlagarde sebastienlagarde merged commit c600341 into HDRP/staging Sep 9, 2020
@sebastienlagarde sebastienlagarde deleted the HDRP/doc_reflectionprobes branch September 9, 2020 19:20
sebastienlagarde added a commit that referenced this pull request Sep 14, 2020
@sebastienlagarde
Revert "Updated documentation of reflection probes (#1468)"
62159d2 
This reverts commit c600341.
sebastienlagarde added a commit that referenced this pull request Sep 16, 2020
@sebastienlagarde
Revert "Revert "Updated documentation of reflection probes (#1468)""
57436c7 
This reverts commit 62159d2.
@sebastienlagarde sebastienlagarde mentioned this pull request Sep 17, 2020
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sebastienlagarde sebastienlagarde sebastienlagarde approved these changes

@JordanL8 JordanL8 JordanL8 approved these changes

Assignees
No one assigned
Labels
HDRP SRP
Projects
None yet
Milestone
No milestone
3 participants
@fredericv-unity3d @sebastienlagarde @JordanL8