✏ Small GitHub formatting optimizations for readability #16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I like the transparency of the public X links given that audio can be relied upon as untampered
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
.mdextension 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 thexmlencoding, 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
Save for the latest one, where I just added a placeholder draft idea. ↩
I'm looking into deploying astropod among others, and I plan to test everything out first in production with DC. ↩