Update: we’ve decided to hosts our specs here at Notion so this entire spec is dead.

We want our tech specs here to be accessible at turnipxenon.com/specs/[slug].

Context

Our blog is kinda dead. Most of the things I write are in the specs or pull requests. I want them to be accessible in my website.

Requirements

• We want to be able to write stuff here, without updating the turnip repository.
  • We want to able to simply query the raw file in Github and be able to extract this information.
• We want to obtain meta about our pages following the PageMeta format in pineapple

Assumptions

Our biggest assumption is that we can call github.com's domain on client side. I know we might encounter some CORS issue, so we might have to resort to fetching the resource on the server-side.

Old solution

• We used to just make a separate blog for them

How does this subscribe to the Turnip Manifesto?

• Fun: The challenge seems fun to implement.
• Delight: I don't need to think hard about this to ensure it's live on turnipxenon.com. We also have a centralized location for our files, so there's less duplication.
• Empathy: It allows non-technical people to see what I do even if the details are not as non-technical friendly.
• Transparency: It's more available for everyone to see.
• Forgiveness: I'm okay with sharing my sub-optimal thoughts with everyone.

Proposed solution

Solution overview

Our solution would be to make a dynamic page in turnipxenon.com/specs and dynamic route as turnipxenon.com/specs/[slug], which gets information from github.com/TurnipXenon/specs server-side.