UBEC Participation Guide - Quick Reference Card

Print this page and keep it handy during implementation

📦 Files Delivered (5 total)

✅ 30-Minute Integration Checklist

Step 1: Review (5 min)

• [ ] Open participation-guide.md
• [ ] Scan content for accuracy
• [ ] Note any UBEC-specific changes needed

Step 2: Decide (5 min)

• [ ] File location: Where will guides live?
• [ ] URL structure: What's the path?
• [ ] Links: How to update relative links?
• [ ] Design: Match site style exactly or simplify?

Step 3: Update (10 min)

• [ ] Fix any inaccurate content
• [ ] Update internal links for your structure
• [ ] Adjust contact emails if needed
• [ ] Confirm all existing guide links work

Step 4: Deploy (10 min)

• [ ] Copy files to chosen location
• [ ] Add link from main docs page
• [ ] Test all navigation paths
• [ ] Verify mobile display

🎯 4 Key Decisions

1. File Location

Option A: /static/docs/guides/       (Simple)
Option B: /docs/guides/               (Rendered)
Option C: Use MkDocs/Docusaurus      (Professional)

My choice: ___

2. URL Pattern

/docs/guides/participation-guide     (Recommended)
/guides/participation                (Shorter)
/community/getting-started           (Alternative)

My choice: ___

3. Links to Update

Current format:

[Guide](../UBEC_Token_Holders_User_Guides.md)

Update to:

[Guide](/docs/UBEC_Token_Holders_User_Guides)

My pattern: ___

4. Design Approach

[✓] Exact match to site CSS
[✓] Similar but optimized for reading
[✓] Separate documentation styling

My choice: ___

📋 Files to Update

In Your Project:

• [ ] templates/docs.html - Add participation guide link
• [ ] static/css/docs.css - Add featured card styling (optional)
• [ ] Navigation/menu - Add guides section
• [ ] Sitemap - Include new pages

Links to Check:

All guides in participation-guide.md reference: - Token Holders Guide - Onboarding Guide - Developer Guide - Governance Guide - Community Organizer Guide - System Administrator Guide - Public Guide

Make sure these exist and links point correctly!

🎨 Quick CSS for Featured Card

.doc-card.featured {
    grid-column: span 2;
    background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
    color: white;
    padding: 2rem;
}

.doc-card.featured .badge {
    background: rgba(255,255,255,0.2);
    color: white;
    padding: 0.25rem 0.75rem;
    border-radius: 12px;
    font-size: 0.875rem;
    display: inline-block;
}

.guide-paths {
    list-style: none;
    padding: 0;
    display: grid;
    grid-template-columns: repeat(2, 1fr);
    gap: 0.75rem;
}

.guide-paths li {
    background: rgba(255,255,255,0.15);
    padding: 0.5rem 1rem;
    border-radius: 8px;
}

🔗 HTML Snippet for Docs Page

Add to "For Communities" section:

<div class="doc-card featured">
    <span class="badge">Start Here</span>
    <h3>Participation Guide</h3>
    <p>Discover your pathway into the UBEC ecosystem...</p>
    <ul class="guide-paths">
        <li>🌱 Farmers & Growers</li>
        <li>🤝 Communities & Cooperatives</li>
        <li>💰 Token Holders</li>
        <li>🎯 Community Organizers</li>
        <li>🏛️ Governance Participants</li>
    </ul>
    <a href="/docs/guides/participation-guide" class="btn-primary">
        Find Your Pathway →
    </a>
</div>

📊 Success Metrics (Track These)

Week 1

• Guide accessible at correct URL ✓
• Zero broken links ✓
• Analytics showing traffic ✓

Month 1

• 100+ guide views
• Lower support ticket volume
• Applications citing guide

Month 3

• 500+ guide views
• Measurable impact on onboarding
• User testimonials

🆘 Quick Troubleshooting

Links Don't Work

→ Check relative paths match your file structure → Verify all referenced guides exist → Test navigation from guide to other docs

Styling Looks Off

→ Emojis not rendering? Remove them or use images → Tables breaking? Simplify or use div-based layout → Mobile issues? Test responsive breakpoints

Content Questions

→ Review existing guides for consistency → Check UBEC style guide if one exists → Consult with content team

Technical Issues

→ Markdown parser compatibility → Check file permissions → Verify URL routing in your framework

📞 Contact Quick Reference

🎯 One-Sentence Summary

What this is: A comprehensive entry point guide that helps prospective UBEC participants understand their options and directs them to appropriate detailed documentation based on their interests and role.

⏱️ Time Investment

✨ What Makes It Good

• ✅ Addresses 8 distinct user types
• ✅ Self-service journey (reduces support)
• ✅ Links to existing guides (no duplication)
• ✅ Comprehensive FAQ section
• ✅ Mobile-friendly structure
• ✅ Aligned with Ubuntu philosophy
• ✅ Ready to deploy with minimal changes

🚀 Deploy NOW (Bare Minimum)

# 1. Copy files (2 min)
cp participation-guide.md /your/project/docs/guides/
cp README.md /your/project/docs/guides/

# 2. Update one line in docs.html (1 min)
# Change:
<a href="#">Participation Guide</a>
# To:
<a href="/docs/guides/participation-guide">Participation Guide</a>

# 3. Test (2 min)
# Click the link, verify page loads

# 4. Deploy (5 min)
# Your standard deployment process

Total: 10 minutes to go live!

💡 Remember

1. Start simple - Basic implementation first, enhance later
2. Test thoroughly - All links, all devices
3. Track metrics - Know what's working
4. Gather feedback - Users will tell you what's missing
5. Iterate quickly - Documentation is never "done"

🎓 The Goal

Help every prospective participant: 1. Understand what UBEC is 2. See where they fit 3. Know their next steps 4. Feel welcomed and included

If the guide does this, it succeeds. Everything else is optimization.

Built with care for the UBEC community.

"I am because we are."

Last Updated: November 8, 2025
Version: 1.0
Status: Ready for Integration

🎯 START HERE: Read DELIVERY_SUMMARY.md for complete overview
📖 THEN: Read IMPLEMENTATION_SUMMARY.md for detailed instructions
🎨 FINALLY: Review VISUAL_MOCKUP.md for design ideas