-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Copy docs to package #6232
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
base: develop
Are you sure you want to change the base?
Copy docs to package #6232
Conversation
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
Co-authored-by: amanda-butler-unity <[email protected]>
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.
Looks good, just a question about the text formatting, also can't we remove the doxygen stuff?
@@ -0,0 +1,20 @@ | |||
# API Reference | |||
|
|||
Our developer-facing C# classes have been documented to be compatible with |
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.
Should our docs be written with line breaks like this? The other package docs seem to not have line breaks for formatting.
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.
It's true that the other package docs don't use line breaks like that. I was going to say something, but when I looked at the local built, it looks like it renders OK. I don't want to ask y'all to fix all of the line breaks if it's not actually necessary.
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.
ah ok, thanks @maryamziaa if there is a fairly automated way of fixing this to remove the line breaks in paragraphs then please do it, otherwise if it's too much work you can leave it as is.
Co-authored-by: Giles Coope <[email protected]>
Co-authored-by: Giles Coope <[email protected]>
Proposed change(s)
Copy the documentation from the webpage into the package and modify it to be compatible with the package format. We're planning to use Unity Package documentation as the primary developer documentation and deprecate the maintenance of web docs.
Types of change(s)
Checklist
Other comments