Skip to content
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

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

Closed
stuij opened this issue Jan 16, 2024 · 3 comments
Closed

Comments

@stuij
Copy link
Member

stuij commented Jan 16, 2024

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
Copy link
Member Author

stuij commented Mar 15, 2024

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:

stuij@605b80b

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
Copy link
Member Author

stuij commented Mar 15, 2024

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
Copy link
Member Author

stuij commented Mar 24, 2024

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.

@stuij stuij closed this as completed Mar 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant