OpenLake / OpenLake/OpenLake--Website

Feature: Set up media handling for blogs

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

Nobody has claimed this yet.

help wanted
Dominant language
TypeScript
Stars
3
Forks
16
Avg merge
8h 54m
Merged PRs (30d)
7

Description

Set up media handling for blogs

This is a sub-issue of #15

Overview

Establish a robust system for managing and displaying media assets (images, diagrams, etc.) within blog posts.

Tasks

  • Create a dedicated /public/images/blogs directory for storing blog media assets
  • Implement a standardized naming convention for media files
  • Define guidelines for image formats, dimensions, and file sizes
  • Set up responsive image handling using modern HTML techniques
  • Create utility functions for optimizing images during build time
  • Implement fallback solutions for missing images
  • Add support for image captions and alt text in Markdown

Technical Details

  • Configure image optimization tools for production builds
  • Implement lazy loading for images to improve performance
  • Establish a consistent path structure for referencing media in Markdown files
  • Create examples demonstrating proper media inclusion in blog posts

Definition of Done

  • Media directory structure is established
  • Images render correctly in blog posts
  • Responsive images work across different screen sizes
  • Documentation includes clear instructions for handling media

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 by reviewing the proposed /public/images/blogs directory and the existing Markdown file structure for blog media references. Identify the build-time image optimization entry point and any existing image-rendering utilities before defining the media conventions. Done means blog images render responsively with captions, alt text, lazy loading, fallbacks, and documented usage examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, markdown, typescript
Domain
documentation, frontend, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.