Skip to content

feat: the blog posts under blog/ have no author metadata or reading time estimate β€” readers cannot identify who wrote an article or gauge reading time before committingΒ #1964

Description

@divyanshim27

πŸš€ Problem Statement

The blog/ directory contains Docusaurus markdown posts. Docusaurus supports rich front matter metadata (authors, reading time, tags, description) but the current blog posts appear to use minimal front matter β€” primarily title, date, and tags.

This creates two user experience gaps:

  1. No author attribution β€” a blog post about "How to Open a Pull Request" doesn't show who wrote it, reducing credibility and community recognition for contributors
  2. No reading time estimate β€” readers can't see "5 min read" before clicking in, reducing content discoverability

Docusaurus 3 (the framework used here, per package.json and docusaurus.config.ts) has built-in reading time estimation and rich author support.

Proposed Fix

1. Enable reading time in docusaurus.config.ts

// docusaurus.config.ts
const config: Config = {
  presets: [
    [
      'classic',
      {
        blog: {
          showReadingTime: true,     // Enable built-in reading time
          readingTime: ({ content, frontMatter, defaultReadingTime }) =>
            defaultReadingTime({ content, options: { wordsPerMinute: 200 } }),
        },
      },
    ],
  ],
};

2. Create blog/authors.yml for reusable author profiles

# blog/authors.yml
sanjay:
  name: Sanjay K V
  title: Founder, RecodeHive
  url: https://www.linkedin.com/in/sanjay-k-v/
  image_url: https://github.com/sanjay-kv.png

# Additional contributors can add themselves here

3. Update existing blog posts to include author front matter

---
title: How to Open a Pull Request
date: 2025-01-15
authors: [sanjay]
tags: [github, opensource, beginners]
description: A step-by-step guide to opening your first pull request on GitHub.
---

This is a low-risk, high-impact change since Docusaurus handles all the rendering automatically once the config and front matter are in place.

Files to Modify / Create

File Change
docusaurus.config.ts Enable showReadingTime: true in blog config
blog/authors.yml New file with contributor profiles
blog/*/index.md Add authors and description front matter

Suggested labels: enhancement, documentation, good first issue

I would like to work on this. Could you please assign it to me?

Metadata

Metadata

Assignees

No one assigned

    Labels

    level 110 pointsrecodethis is label for leaderboard

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions