Announcement

Collapse
No announcement yet.

Reporting Issues for Documentation

Collapse
This is a sticky topic.
X
X
  • Filter
  • Time
  • Show
Clear All
new posts

  • started a topic Reporting Issues for Documentation

    Reporting Issues for Documentation

    First off, thank you for taking the time to help us improve UE4 Documentation!

    We request that issues found within documentation please be submitted within this thread (this may change at a later date). 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 allow us to track each issue more easily.

    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 what the defect is.
    • Again, please make a new reply for each separate issue, and use the following format whenever you are able:

    Engine version: The version number of the Unreal Engine which you are currently using. For example: 4.7.2. This is mainly for when you are reporting an issue, that a certain portion of documentation is out-of-date, and to show what version of the engine this was checked against.

    Detailed description of the issue: Please remember to include all potentially relevant information (what page you were on, where the issue is located, linking to the page itself).

    Screenshots: We encourage you to include a screenshot(s) whenever they may prove 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 primarily 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 thank each and every one of you very much for your help!

  • commented on 's reply
    This issue should be fixed now. You may have to force the page to reload (Ctrl+F5 or Shift+F5) to get it to update though.

  • commented on 's reply
    This must have slipped through. I will get it fixed ASAP.

  • replied
    Didn't find better place to repport that, but it seems that the Documentation for BlueprintAPI, on google Chrome windows 10, has an error code turning into an infinite loop loading CPU usage. https://docs.unrealengine.com/en-US/...API/index.html
    All of its children seems to suffer that issue too, I can't test further cause it hurts my hardware way too much.

    Leave a comment:


  • commented on 's reply
    I checked on this, and we're working on updating a redirect to fix this issue.

  • commented on 's reply
    It looks like the correct link is this: https://docs.unrealengine.com/en-US/...rds/index.html

    Did you have the other link saved, or are you getting to it from a specific page?

  • commented on 's reply
    Thanks for reporting this issue. I'll pass this along to the appropriate contact here at Epic.

  • commented on 's reply
    Thanks for reporting this issue. I'll pass this along to the appropriate contact here at Epic.

  • replied
    Linking error in "PSO Caching guide"

    Engine version
    : N/A

    Detailed description of the issue: After searching for "PSO" in search bar, and the clicking at the first result "PSO Caching - docs.unrealengine.com" , user lands at docs index page, not at the desired page describing PSO caching.

    Additional info:
    Upon some investigation, it seems that the URL is at fault. That is, Faulty URL returned by the search is "https://docs.unrealengine.com/en-US/...ing/index.html" but remove the "-" from between "PSO" and "Caching" (this results in this URL https://docs.unrealengine.com/en-US/...ing/index.html) and the proper page loads.

    Leave a comment:


  • replied
    Hello guys,
    I can’t have access to that tutorial on the documentation.
    looking to make a widget virtual keyboard.
    https://docs.unrealengine.com/latest...tup/index.html
    The page doesn’t exist and clicking on it make me land on the general page.

    Thanks for your help guys,

    Regards,
    Matthieu

    Leave a comment:


  • commented on 's reply
    Thanks for reporting this issue. I'll pass this along to the appropriate contact here at Epic.
    Note: We're doing some content migration at the moment, so this could take a week or so. I'll make sure that there's an internal bug to track the issue.

  • replied
    https://docs.unrealengine.com/en-us/...Guide/MathNode

    in the first example some html mixed with the code, look:
    <code class="language-cpp">(1+x)*sin(myVar)-2.4/rand()</code>

    Leave a comment:


  • commented on 's reply
    Thanks for reporting this issue! I took a quick look at the page, and it appears that the issue (***) has been fixed already. (I know the author has been doing some updates in that area, so he may have simply fixed the issue before I took a look.)
    Thanks for pointing this out!

  • replied
    Originally posted by SlothSimon View Post
    Engine version: 4.22

    Description: Incorrect Chinese Translation

    Details: In link http://api.unrealengine.com/CHN/Prog...rence/Classes/, it says "因此在 ClassName.h 的顶端不许出现以下行", meaning the following line shouldn't appear in ClassName.h. But actually, in English doc, it says "So, at the top of ClassName.h, the following line must appear:"
    Hey, SlothSimon. I've referred this to our localization team, and they'll review the translation. Thanks!

    Leave a comment:


  • replied
    Engine version: 4.22

    Issue: Typo on this page https://docs.unrealengine.com/en-us/...ing/RayTracing
    • Also, you have to consider that more ray tracing features are being used, such *** reflections and translucency

    Leave a comment:

Working...
X