thefrontside / thefrontside/frontside.com

make related articles easier to maintain

Open
#136 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
4
Forks
4
PR merge metrics
No merged PRs in 30d

Description

We currently use a custom html component in our markdown blog post files to curate content for the users. This is difficult to maintain as our styles are baked into the blog posts, and the content (title, description, etc.) are duplicated.

https://github.com/thefrontside/frontside.com/blob/1d51d53a375cb0d46d057067cbd7df60303cb920/src/pages/blog/2021-18-02-there-and-back-again-testing-and-upgrades.md#related-article

We can instead put a reference to a page slug in the blog post frontmatter, and using that, pull the related data out of the graph.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked blog post at src/pages/blog/2021-18-02-there-and-back-again-testing-and-upgrades.md, especially its related-article section and frontmatter. Trace how the site reads blog content and pulls data from the graph. Done means related articles use page-slug references and no longer duplicate titles, descriptions, or styles in each post.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
content, frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.