Reporting Issues for Documentation

[BenGittins]

Hi Unreal Doc QA!

I have just found an issue on the Level Designer Quick Start Page (https://docs.unrealengine.com/en-US/...art/index.html).

Within the page, there is a lot of formatting issues, with text and images overlapping.
In the image below, the web page is zoomed out so that an overview of the issue may be observed.


The only section affected by this is section 3.
I am viewing the web page in firefox 79.0.

Kind Regards,
Ben

[echo_four]

Hey BenGittins! Thanks for reaching out to us. Could you try reattaching the image (I don't see it) or try sending it to me directly? Also, let me know if you seem to experiencing this issue on any other pages.

[Rainoxer]

Hello there!


I found a problem on this page : https://docs.unrealengine.com/en-US/...age/index.html


Note that it happened the first time I loaded the page, when I looked for the word "scaling" with CTRL+F and went down to this section.
Then I refreshed the page and it's now correctly displayed.

[echo_four]

Hey Rainoxer! Thanks for passing this along to us. That's so weird. I'm using Chrome and I don't see any issues. What browser are you using?

[jazznazz]

Chrome 85, also (vanilla) Firefox 80. when I press "Ctrl", the scroll bar at the right of the page disappears . and I cannot scroll in any way. same thing when I press Win+D.

[echo_four]

Hey jazznazz! Thanks for reaching out to us and I'm sorry that's giving you trouble. This sounds really strange. I've made a ticket so that we can look into this. Let us know if you have any other details concerning this issue (ex. Which OS you're using, does this happen on other pages, etc.).

[echo_four]

Hello again jazznazz. I just wanted to give you an update on this. We looked into this issue and were unable to reproduce it. Please let us know if you're still having trouble and if so we can take another look.

[doomsdαy]

Detailed description of the issue:

Working with Modular Characters
https://docs.unrealengine.com/en-US/...shmergeexample

All TArray types are missing in the Mesh Merge Example section .h code sample


Additional info that is helpful: Firefox & Chrome in Desktop & mobile

sadly, it's been three months since this post and still no fix to this issue, any update on this?

alternatively it would be cool if you guys made one of those live streams about modular characters which is a really important topic

[echo_four]

Hey doomsdαy! Sadly, I don't have much of an update. Your initial request was ticketed and passed along to the team. However, it's still waiting to be resolved. I've bumped the ticket to see if there's anything I can do to help it get some traction. I've also added your other request (regarding the live streams).

Thanks for your patience and sorry for the delay. The docs team is working on a lot of great stuff, and unfortunately edits like this can take some time.

[Element808]

Found an issue on this page of the documentation site: https://docs.unrealengine.com/en-US/...ine/index.html

Was trying to reference some GitHub information on this or a page that's linked from that page and it's coming up with 403 errors for lots of resources including the index page itself.

Windows 10 w/ Chrome Browser. Also tested with latest Edge, just to be sure and the same result.

[echo_four]

Hey Element808. Thanks for pointing this out to us. I've passed your feedback along to the rest of the team. I'll try and give you an update once I know more.

[Tengu]

I'm working through the Action RPG example, and the 'Adding a Pickup' online documentation link is dead:

https://docs.unrealengine.com/en-US/...kUp/index.html

Goes nowhere.

Really interested in reading that, that was my next thing to try

[echo_four]

Hey Tengu! thanks for pointing that out to us. So sorry that it's giving you trouble. I've passed along your comments to the rest of the Docs team so we can look into what's going on there. I hope to give you an update soon when that link is fixed. In the meantime, please let us know if you find anything else that looks off.

[Banashark]

Found an issue on this page of the documentation site: https://docs.unrealengine.com/en-US/...ine/index.html

Was trying to reference some GitHub information on this or a page that's linked from that page and it's coming up with 403 errors for lots of resources including the index page itself.

Windows 10 w/ Chrome Browser. Also tested with latest Edge, just to be sure and the same result.

I'm also hitting this issue when attempting to view quite a few pages. It appears to do a 302 to a page that gives a 403.

Pages I've seen include:
https://docs.unrealengine.com/en-US/...nts/index.html
https://docs.unrealengine.com/en-US/...ing/index.html

The interesting thing with the latter is that it replaces the URL with https://docs.unrealengine.com/en-US/...ing/index.html (notice "LevelStreaming" -> "Levels/treaming"). However the former doesn't do this.

Are there any backup docs to reference while these things are broken?

[echo_four]

Hey Banashark, thanks for reaching out to us. I've added your comments to the ticket I opened for Element808. We're working hard to fix any issues that have arisen as a result of our 4.26 updates. We currently don't produce any backups that we could share with you. Hopefully we can get these issues resolved soon. I'll try and provide an update once I know more.

[Lyverbe]

Spelling error
Location: https://docs.unrealengine.com/en-US/...lds/index.html
Header reads "An overview of Mesh Destance Fields and its available features that you can use when developing your games."

"Destance" should be "Distance"

[echo_four]

Hey Lyverbe! Thanks for the heads up. I've made a ticket and we'll look into fixing that typo asap.

[nullterm]

As mentioned by a few other people, keep hitting issues with C++ documentation redirecting to the main page.

https://docs.unrealengine.com/en-US/...ent/index.html

[echo_four]

Hey nullterm, thanks for reaching out to us. I've added this document to a list of pages we need to look into. We appreciate your patience as we look into resolving these issues. Hang in there, and we hope to have more info soon.

[livada]

Code example for Conversion Routines on Character Encoding page in C++ docs produces an error.

Link to the docs page...

FString String;
...
FTCHARToANSI Convert(*String);
Ar->Serialize((ANSICHAR*)Convert, Convert.Length()); // FTCHARToANSI::Length() returns the number of bytes for the encoded string, excluding the null terminator.

Convert variable can't be cast to 'ANSICHAR*', Get() method should be used like this:

FString String;
...
FTCHARToANSI Convert(*String);
Ar->Serialize((ANSICHAR*)Convert.Get(), Convert.Length()); // FTCHARToANSI::Length() returns the number of bytes for the encoded string, excluding the null terminator.

[echo_four]

Hey livada, thanks for reaching out to us. I've passed your feedback along so we can take a closer look. Please let us know if you spot anything else that looks off.

[southrop]

Developers Folder
https://docs.unrealengine.com/en-US/...der/index.html

2. Since this is meant to be strictly personal work, it is a good policy to never reference work from this folder to anywhere outside your folder.

The wording here is quite confusing and could possibly be interpreted both ways. My understanding is work outside of the folder should never reference stuff inside the folder, but the Japanese translation actually says work inside the folder should not reference work outside the folder. That would imply that work outside the folder can use things inside this folder, which seems counter intuitive for a folder containing personal experiments/tests. It would make much more sense for your personal test files to reference things that are actually already implemented in the game (e.g. to test if an implementation might work before actually committing to it).

Either way, it would be nice if this could be clarified and any relevant translations updated.

[echo_four]

Hey southrop! Thanks for the recommendation. I've added your feedback to a ticket and passed it along to the rest of the Docs team. I'll talk to them and see what we can do to update the wording on this page.

[chrudimer]

Hi, in the Collision Overview https://docs.unrealengine.com/en-US/...iew/index.html under "Collision", in the image of "Sphere Collision Setup" it seems to me that World Dynamic should be outlined instead of World Static, since it should block the Wall which is of type World Dynamic and the description below the image says

In this case, the sphere is a PhysicsBody and it is set to block WorldDynamic (which is what the wall is).

[echo_four]

Hey chrudimer, good catch. I'll pass this feedback along so we can get that page update asap. Please let us know if you find anything else like this that seems off.

[unit23]

Where is the Open World DemoCollection, explained here
https://docs.unrealengine.com/en-US/...art/index.html

The current launcher Learn tap is not showing it.

UPDATE
Found it in my Vault.

[echo_four]

Hey unit23. So we're cool?

[unit23]

echo_four I guess, I just find it a little confusing that some of the Learn tap items are in my vault but not on Learn tap display. So perhaps it has been removed from the Learn tap, in which case I would edit the cited documentation and notify users about it.

Also there could be an explanation about How to rebuild the Grass map, what it does etc.

[echo_four]

Ah gotcha. Well thanks for these additional notes. I'm actually working with someone to update our documentation on Vault content management (based on an earlier piece of forums feedback). *** for the grass map, I can certainly pass that feedback along.

[southrop]

Hi,

I noticed that the docs page for Chaos Physics in Japanese seems to have mojibake. There's probably an encoding issue with the source file.
https://docs.unrealengine.com/ja/Int...ics/index.html

Also curiously, Chaos Destruction doesn't appear as an entry under Chaos Physics in the Japanese docs, but appears directly under Physics, which is inconsistent with the English docs.
https://docs.unrealengine.com/ja/Int...ion/index.html

Cheers

[echo_four]

Hey southrop! Thanks for pointing these items out to us. I've reached out to some colleagues to see what we can do about fixing these.