search

jetmore / swaks

Swaks - Swiss Army Knife for SMTP
http://jetmore.org/john/code/swaks/
GNU General Public License v2.0
847 stars 86 forks source link

docs: "Rendered" `base.pod` has been broken since Jan 2017 #90

Open polarathene opened 5 months ago

polarathene commented 5 months ago

This commit (Jan 2017) broke the rendering of the docs on Github. Whereas the prior commit renders correctly as you can see by viewing the two links.

The README implies the base.pod link is meant to be rendered:

The reference documentation from the latest release, which includes quick-start examples, is available as plain text and rendered.

Is a rendered version no longer available for easy viewing in the browser?

jetmore commented 5 months ago

Interesting. I am fairly sure this document rendered as recently as a month ago as I was referring to it as I was working on Swaks. My suspicion is that github has enacted some limit on what files get rendered automatically (or changed already-existing limits). The base.pod from prior to 2017 is less than 1000 lines and the one from 2024 is more than 1000 lines, and the file size obviously changed too. I'll see if there's a way to prove that and whether it can be changed. If not I'll just render it to html.

man8 commented 2 months ago

Interesting. I am fairly sure this document rendered as recently as a month ago as I was referring to it as I was working on Swaks.

I have proof that it was working as of 23 November 2023 around 14:00 UTC 😀. Here's a screenshot:

swaks-working-github-pod-formatting-as-of-20231123

polarathene commented 2 months ago

I have proof that it was working as of 23 November 2023

I don't see a date in the screenshot. Does it still render like that for you now, or it's also broken?

The git history at that time does not render for me (only checked on Vivaldi / Chrome, Windows 11).

This commit would have been the last one before Nov 23 2023? Your commit history view however shows a commit from Oct 15 2020 which does not render for me:

image

I thought maybe it was the tag you were browsing, but switching to that did not help either:

image

Rendering for the two commits I highlighted originally is still the same with broken and working.

man8 commented 2 months ago

I have proof that it was working as of 23 November 2023

I don't see a date in the screenshot. Does it still render like that for you now, or it's also broken?

Apologies for not explaining properly. Yes, as of today, every version of the .pod that I try to open seems to fail to render for me. [CORRECTION BELOW] My intent with the message above was to confirm @jetmore's suspicion that it used to work and that the issue doesn't appear to have been introduced in a commit to this repo.

You're also correct that my screenshot doesn't show a timestamp, but it's from an image that I know was created at that time. If anyone wants, I'd be happy to supply a un-cropped, redacted version showing my entire screen at the time, with the local system date/time. It's testimony, not evidence 😄

CORRECTION: actually, the situation seems to be more complex. As of today, with cleared caches, Safari 17.4.1: