Skip to content

Releases: garyblankenship/gist-blog

v2.1.0 - Clean Documentation Structure

30 Aug 19:00
@garyblankenship garyblankenship
v2.1.0
4d56eda
Compare
Choose a tag to compare
v2.1.0 - Clean Documentation Structure Latest
Latest

🧹 Gist Blog v2.1.0 - Clean Documentation Structure

✨ What's New

This release brings a completely reorganized documentation structure, eliminating clutter and redundancy while maintaining all essential information.

📚 Documentation Improvements

Before vs After

  • 16 scattered files → 8 focused documents (50% reduction)
  • ~60% duplicate content eliminated
  • Root directory cleaned (markdown files properly organized)
  • Clear hierarchical structure in docs/ directory

New Clean Structure

/
├── CLAUDE.md           # AI assistant instructions
├── README.md           # Project overview
└── docs/
    ├── CLI_GUIDE.md              # Complete CLI documentation
    ├── DEPLOYMENT_GUIDE.md       # All deployment instructions
    ├── CONTENT_ENHANCEMENT_GUIDE.md  # H2-only content principles
    ├── ARCHITECTURE.md           # Technical details
    ├── QUICK_REFERENCE.md        # Cheat sheet
    ├── DEPRECATED.md             # Migration guide
    ├── RELEASE_NOTES.md          # Version history
    └── examples/                 # Example content

🔧 Other Improvements

  • memory.md removed from git tracking (added to .gitignore)
  • Generic wrangler.toml.example for easier deployment
  • Consolidated guides for better maintainability

📦 For New Users

Getting started is now easier than ever:

  1. Start with README.md for overview
  2. Follow docs/DEPLOYMENT_GUIDE.md for setup
  3. Use docs/CLI_GUIDE.md for local tools
  4. Apply docs/CONTENT_ENHANCEMENT_GUIDE.md for better content

🚀 No Breaking Changes

This is a documentation-only release. All functionality remains the same.

📝 Commit Summary

  • 4d56eda refactor: clean and reorganize documentation structure

Upgrade: Simply git pull to get the cleaner structure. No deployment needed.

Assets 2
Loading

v2.0.0 - Content Enhancement System & Full Pagination

30 Aug 18:44
@garyblankenship garyblankenship
v2.0.0
ea5b69f
Compare
Choose a tag to compare
v2.0.0 - Content Enhancement System & Full Pagination

🚀 Gist Blog v2.0.0 - Content Enhancement System

✨ Highlights

This major release transforms how content is managed and displayed, introducing the H2-Only TL;DR Principle and comprehensive gist pagination support.

🎯 Key Features

Content Enhancement System

  • H2-Only Reading: Articles optimized for 30-second scanning
  • Dual-Purpose Content: Serves both quick scanners and deep readers
  • Propositional Headlines: Each H2 delivers standalone value
  • Template-Driven Enhancement: Systematic content improvement workflow

Improved Filtering & Pagination

  • Full Collection Support: Fetches ALL gists (up to 1000) instead of just 30
  • Strict Tag Filtering: Only displays gists with hashtags in descriptions
  • Smart Code Exclusion: Filters out pure code files without blog content
  • Efficient API Usage: 100 gists per page with safety limits

📚 New Documentation

  • ARTICLE_ENHANCEMENT_TEMPLATE.md - Complete template system
  • GIST_REFACTORING_STRATEGY.md - Step-by-step enhancement workflow
  • H2_ONLY_READING_GUIDE.md - Deep dive into skimmability
  • ENHANCEMENT_INSTRUCTIONS.md - Quick reference guide
  • TEMPLATE_EXAMPLE_NOSTALGIA.md - Real-world application

🔧 Technical Improvements

  • Enhanced worker.js with pagination support
  • Improved GitHub API integration
  • Better content filtering logic
  • Optimized KV cache management

🚨 Breaking Changes

⚠️ Gists without hashtags will no longer display

  • Add hashtags to gist descriptions to make them visible
  • Example: My Article Title #blog #thoughts

📦 Installation

Deploy to Cloudflare Workers

  1. Clone the repository
  2. Copy wrangler.toml.example to wrangler.toml
  3. Configure your settings
  4. Deploy:

```bash
npm install
wrangler secret put GITHUB_USER
wrangler secret put GITHUB_TOKEN
wrangler secret put SITE_URL
wrangler secret put SITE_NAME
wrangler deploy
```

🎉 What's New for Readers

  • 30-Second Understanding: Get the full story from headings alone
  • Cleaner Blog: No more code-only gists cluttering the feed
  • Better Structure: Enhanced articles with clear progression
  • All Your Gists: Now displays your entire collection (up to 1000)

🛠️ What's New for Developers

  • Content Templates: Structured approach to article enhancement
  • Workflow Documentation: Complete guides for content transformation
  • Generic Config Example: Easy setup for new deployments
  • Improved Filtering: Precise control over what appears

📊 Performance

  • Supports up to 1000 gists (33x improvement)
  • 5-minute cache TTL for optimal performance
  • Global edge deployment via Cloudflare Workers
  • Efficient pagination with 100 items per page

🙏 Acknowledgments

Thanks to all contributors and the Cloudflare Workers platform for excellent edge computing capabilities.

📝 Full Changelog

  • 0dc1f90 feat: improve gist filtering and pagination
  • 214836b docs: add comprehensive content enhancement system
  • dd8f000 chore: update project memory and gitignore
  • bd2a961 docs: add release notes for v2.0.0
  • ea5b69f docs: add generic wrangler.toml.example
Loading