search

ARM-software / abi-aa

Application Binary Interface for the Arm® Architecture
Other
938 stars 188 forks source link

Some documents have stopped rendering in the preview mode in the Github UI #236

Closed stuij closed 6 months ago

stuij commented 8 months ago

The ones that currently don't render are: aaelf32, aapcs32, aapcs64, bpabi32, clibabi32, cppabi32, sysvabi64, vfabi64. The rest of the documents do render correctly.

So for example https://github.com/ARM-software/abi-aa/blob/main/aapcs64/aapcs64.rst

I'm guessing it's changes in the render code as some of those docs haven't changed in a while except for release date changes. We'd have to do some triangulation on one of the smaller documents to see what's exactly tripping up the parser.

stuij commented 6 months ago

I did some testing, and it turns out that the issue is with the size of the document.

I varied the amount of text in the document until at some point it rendered, but adding a single harmless character will make it not render anymore:

https://github.com/stuij/abi-aa/commit/605b80b5ac13cc9f5e35a2c73accc18c4eb2e08b

There's a forum post on this, but so far there hasn't been a solution yet: https://github.com/orgs/community/discussions/86715

I filed a ticket with GitHub Support. Hopefully this issue will be picked up. Otherwise we need to look into a more drastic solution.

stuij commented 6 months ago

Reply on the GitHub Support ticket:

"Thanks for reaching out to GitHub Support to report problems rendering reStructuredText files. We have received other reports of this and our team is currently working to fix this. Looking at the internal issue where this is being worked on it looks like we are close to being able to release this. We will let you know when this fix has been pushed to production."

stuij commented 6 months ago

Currently all the documents are rendering in the browser again :D

I got no qualified reply on the nature of the changes but I'll take it. Closing the ticket.