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

✏ Small GitHub formatting optimizations for readability #16

Merged
merged 5 commits into from
Jan 14, 2025

Conversation

JFWooten4
Copy link
Member

I'm working around different open frameworks to migrate this repo into the actual podcast session. Alongside our community ideation so far, I thought it could help to make the present GitHub pages just a little more readable with some basic formatting. It might not be super apparent how this helps looking at the technical code, but it should appear much more readable once you preview its final deployment.

Changes

Renamed files

I'm leaving everything with the .md extension for now since it's the easiest to natively display here with basic formatting. As this grows to the actual feed and potential standalone site, we can use existing tools like HTML converters for the xml encoding, e.g.

Updated episode titles

This part is still up in the air depending on how everything works out with Discussions/Issues for ideation alongside Discord and others. I've just added some basic formatting since some titles were missing here but live in the feed.1 The biggest thing here is how the repo handles slugs, which depends on the larger pending deployment framework.2

Converted plain text links

This is a small upgrade which AFAIK works just fine with the podcast apps. A style thing that seems like a no-brainer to me. That said, it presumes listeners can see on their screen that a word is linked, which I think is reasonable for the larger benefit of better readability.

Added sections for featured guests

An idea I had on a whim, alongside the general ethos of attributing authors. As we continue to have more well-known one-off appearances, perhaps this could be a searchable draw for new listeners. At the very least, it helps collaborators receive attention from their time and effort in chatting with us.


Requesting review from Chives since this touches a lot of the content he wrote.

Footnotes

  1. Save for the latest one, where I just added a placeholder draft idea.

  2. I'm looking into deploying astropod among others, and I plan to test everything out first in production with DC.

@tehchives
Copy link
Contributor

Catching up on review requests - everything here sounds great for me, and I definitely appreciate adding in the titles to navigation so it's easier at a glance for a person to review. I do not know if any changes to plaintext for links will matter for how RSS feed is handled, we may simply need to experiment with some older episode and then expand changes outward from there if unsure. A featured area to browse by guest is a great forward thinking idea - perhaps a similar concept would be thinking of hashtags for episodes to help identify host, broad subject matter covered, etc.

As of now the RSS feed is still on a different GitHub but that is on the short list to change over. Per @BibicJr I believe we'll need to get a new perm link for WhyDRS repo feed and then provide that out to all podcast platforms.

@tehchives tehchives merged commit 8098168 into main Jan 14, 2025
1 check passed
@JFWooten4 JFWooten4 deleted the link-md-formatting branch January 14, 2025 22:53
@JFWooten4
Copy link
Member Author

As for the new perm link, I've been slacking on getting this one up, and I formalized the work to be done in #20. Once this is finished, there will be somewhere for Bibic to redirect to as per group chat between them and us on Dec 9.

@BibicJr
Copy link
Contributor

BibicJr commented Jan 18, 2025

My only comment is with plain text link: Basically, not every podcast platform was able to manage hyperlink html code. I tried to do proper hyperlinks first, but on some platforms the text would be there, but there would be no link. Using the long URL to be the hyperlink was my way around it. I'm not sure how other podcasts are able to get hyperlinks working on all platforms. (Maybe they don't bother?)

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

Successfully merging this pull request may close these issues.

3 participants