Skip to content

UPDATE_LINKS_GUIDE.md

Latest commit

 

History

History
262 lines (191 loc) · 5.87 KB

UPDATE_LINKS_GUIDE.md

File metadata and controls

262 lines (191 loc) · 5.87 KB
Raw

Quick Guide: Update All Announcements with Ecosystem Links

How to quickly add the three SigMap component links to existing announcement files.

🔗 The Three Links

Always include these together:

🔧 SigMap Tool:          https://github.com/manojmallick/sigmap
📚 SigMap Docs:          https://manojmallick.github.io/sigmap/
📊 SigMap Benchmark:     https://github.com/manojmallick/sigmap-benchmark-suite

📝 Quick Find & Replace

In PLATFORM_ANNOUNCEMENTS.md

Find:

GitHub: https://github.com/manojmallick/sigmap-benchmark-suite

Replace with:

SigMap Ecosystem:
  🔧 Tool:     https://github.com/manojmallick/sigmap
  📚 Docs:     https://manojmallick.github.io/sigmap/
  📊 Benchmark: https://github.com/manojmallick/sigmap-benchmark-suite

Locations to update:

  • LinkedIn post (multiple places)
  • Dev.to article (resources section)
  • Email announcement
  • Reddit posts (each post)
  • HackerNews post
  • Slack/Discord posts

In TWITTER_PREMIUM_OPTIMIZED.md

Thread 1, Post 9 (Update CTA):

Old:

GitHub: https://github.com/manojmallick/sigmap-benchmark-suite

New:

SigMap Ecosystem:
  📦 Tool:    github.com/manojmallick/sigmap
  📚 Docs:    manojmallick.github.io/sigmap/
  📊 Dataset: github.com/manojmallick/sigmap-benchmark-suite

Thread 1, Post 1 (Update Hook):

Old:

Let me share what we found 🧵
GitHub: https://github.com/manojmallick/sigmap-benchmark-suite

New:

Part of the larger SigMap ecosystem. Let me explain 🧵
GitHub: https://github.com/manojmallick/sigmap-benchmark-suite

Thread 2, Post 1 (Add Ecosystem Intro):

Add before "Here's the methodology":

Part of the SigMap ecosystem:
📦 Tool: github.com/manojmallick/sigmap
📚 Docs: manojmallick.github.io/sigmap/
📊 Data: github.com/manojmallick/sigmap-benchmark-suite

Thread 3, Post 1 (Update CTA Intro):

Old:

Ready to use SigMap for your own research/tool?

New:

Ready to use the complete SigMap ecosystem?

Complete ecosystem:
📦 Tool: github.com/manojmallick/sigmap
📚 Docs: manojmallick.github.io/sigmap/
📊 Dataset: github.com/manojmallick/sigmap-benchmark-suite

How to get started 🧵

🎯 Most Important Updates

Priority 1 (Must Update):

  • TWITTER_PREMIUM_OPTIMIZED.md — Posts 1 & 9 of each thread
  • PLATFORM_ANNOUNCEMENTS.md — LinkedIn & Reddit sections
  • Main README.md — Add ecosystem table

Priority 2 (Should Update):

  • Dev.to article
  • Email announcement
  • GitHub discussions post
  • HackerNews post

Priority 3 (Nice to Have):

  • Slack/Discord posts
  • Papers with Code entry
  • Academic mailing lists

📊 Where Ecosystem Links Should Appear

Platform Location Context
Twitter Post 1 & final post of each thread Intro + CTA
LinkedIn Beginning + resources section Context + links
GitHub Main README + discussions Overview
Dev.to Resources section External links
Reddit Opening post Ecosystem intro
Email Key section Complete ecosystem
HackerNews Post text Technical context

✨ Messaging Framework

When Introducing Ecosystem:

"The SigMap ecosystem consists of three components:

🔧 Tool — The context extraction implementation
📚 Docs — Complete integration guide  
📊 Benchmark — Large-scale evaluation (this project)

Together, they provide everything needed for context extraction research."

When Linking:

"For implementation details: github.com/manojmallick/sigmap
For usage guides: manojmallick.github.io/sigmap/
For evaluation & research: github.com/manojmallick/sigmap-benchmark-suite"

In CTA:

"📥 Start here:
1. Explore the tool
2. Read the documentation  
3. Download the benchmark dataset
All open-source, CC-BY-4.0 licensed."

🚀 Quick Update Process

  1. Open PLATFORM_ANNOUNCEMENTS.md
  2. Find all instances of GitHub links
  3. Replace standalone GitHub links with ecosystem format
  4. Update intro/hook sections to mention ecosystem
  5. Save

Time: 10-15 minutes to update all platforms

📋 Verification Checklist

After updating, verify:

  • All three links present in each announcement
  • Links formatted consistently
  • No broken URLs
  • Ecosystem context clear
  • Call-to-action updated
  • Hashtags updated if needed
  • Character count OK for Twitter (if edited)

💡 Best Practices

✅ DO:

  • Use consistent formatting for the three links
  • Explain relationship between components
  • Provide multiple entry points based on user needs
  • Keep links up-to-date

❌ DON'T:

  • Include only one link (incomplete picture)
  • Use different formats across platforms
  • Forget to update CTAs
  • Break existing URLs

🔄 Maintenance

After initial update, keep ecosystem links current:

  • Check links monthly for accessibility
  • Update if repos move or URLs change
  • Add new components if created (e.g., CLI tool)
  • Maintain consistency across all platforms

📞 Reference Quick Links

Always have these ready:

Tool:      https://github.com/manojmallick/sigmap
Docs:      https://manojmallick.github.io/sigmap/
Benchmark: https://github.com/manojmallick/sigmap-benchmark-suite
Primary:   https://doi.org/10.5281/zenodo.19898842
Extended:  [Pending Zenodo]

Copy-paste as needed in announcements.

🎯 Result After Update

Before:

  • Mentions only benchmark repo
  • Incomplete picture of project
  • Users don't know about tool or docs

After:

  • All three components visible
  • Complete ecosystem understanding
  • Users can choose their entry point
  • Professional, cohesive project image

Total update time: 15-20 minutes
Impact: Much stronger, more complete project presentation
Effort: Minimal (mostly copy-paste with finds/replaces)