Jump to content

Reporting Issues for Documentation


photo

Recommended Posts

First of all, we would like to thank you for taking the time to help us make our documentation better!

We request that issues found within documentation please be submitted within this thread . If you have multiple issues to report, we ask that you use your best judgment and if need be make a separate reply for each. This will make tracking of each issue easier.

HOW TO REPORT ISSUES WITHIN THIS THREAD

• Please remember to always Search the thread first, to see if your issue has already been reported.
• If your issue has not been previously reported, then please proceed to reply to this thread specifying the problem.
Please make a new reply for each separate issue, and use the following format whenever you are able:

SDK version: The version number of the Unigine SDK you are currently using. For example: 2.4.1. This is used when you are reporting an issue, that a certain part of documentation is out-of-date, and to indicate the SDK version this was checked against.

Detailed description of the issue: Please don’t forget to include all potentially relevant information (the page you were on, the place where the issue is located, with a link to the page itself).

Screenshots: We encourage you to include a screenshot(s) whenever they may be helpful in understanding the issue.

Additional info that is helpful: Browser used, how you were viewing the documentation (mobile, tablet, second monitor with different resolution). This will be helpful when there appears to be a formatting issue present. Example: I was viewing the documentation on a tablet and the search window is cutoff and unable to use.


What kind of issues are we asking about?
• Out-of-date information
• Spelling or Punctuation errors
• Out-of-date image(s)
• Link errors (Wrong page, 404, ex...)
• Formatting Issues


Once again, we would like to thank you very much for your help in improving our documentation!

Link to comment
  • fox pinned this topic
×
×
  • Create New...