Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

DEPLOYMENT CHECKLIST

Varun Pratap Bhardwaj edited this page May 24, 2026 · 2 revisions

Wiki Deployment Checklist

Quick reference for deploying updated wiki pages to GitHub.


Pre-Deployment Verification

βœ… Files Ready

  • Home.md - Updated with v2.1.0 features
  • _Sidebar.md - New navigation added
  • _Footer.md - Creator attribution added
  • Universal-Architecture.md - Renamed and updated from 4-Layer-Architecture.md
  • MCP-Integration.md - NEW - Complete MCP guide
  • Universal-Skills.md - NEW - Complete skills guide
  • Installation.md - Updated with v2.1.0 setup
  • FAQ.md - Updated with v2.1.0 questions

βœ… Content Verification

  • All v2.1.0 features documented
  • Creator attribution on every page
  • SEO keywords naturally integrated
  • Internal links use [[Page-Name]] format
  • No fabricated information
  • Code examples accurate
  • IDE count correct (11+)

Deployment Steps

Step 1: Navigate to GitHub Wiki

  1. Go to: https://github.com/qualixar/superlocalmemory/wiki
  2. Click "Edit" on the sidebar (or "New Page")

Step 2: Update Existing Pages

Home:

  1. Click "Home" in wiki
  2. Click "Edit"
  3. Copy content from wiki-content/Home.md
  4. Paste and save

Installation:

  1. Click "Installation" in wiki
  2. Click "Edit"
  3. Copy content from wiki-content/Installation.md
  4. Paste and save

FAQ:

  1. Click "FAQ" in wiki
  2. Click "Edit"
  3. Copy content from wiki-content/FAQ.md
  4. Paste and save

Step 3: Rename Architecture Page

Option A - If GitHub supports renaming:

  1. Click "4-Layer-Architecture" in wiki
  2. Click "Edit"
  3. Change page name to "Universal-Architecture"
  4. Copy content from wiki-content/Universal-Architecture.md
  5. Save

Option B - If GitHub doesn't support renaming:

  1. Create new page "Universal-Architecture"
  2. Copy content from wiki-content/Universal-Architecture.md
  3. Save
  4. Delete old "4-Layer-Architecture" page
  5. Update any links pointing to old page

Step 4: Create New Pages

MCP-Integration:

  1. Click "New Page"
  2. Name: "MCP-Integration"
  3. Copy content from wiki-content/MCP-Integration.md
  4. Save

Universal-Skills:

  1. Click "New Page"
  2. Name: "Universal-Skills"
  3. Copy content from wiki-content/Universal-Skills.md
  4. Save

Step 5: Update Sidebar

  1. Click "Edit Sidebar" (usually in right panel)
  2. Copy content from wiki-content/_Sidebar.md
  3. Paste and save

Step 6: Update Footer

  1. Click "Edit Footer" (usually in right panel)
  2. Copy content from wiki-content/_Footer.md
  3. Paste and save

Post-Deployment Verification

βœ… Check Links

Visit each page and verify:

Home Page:

  • "Universal Architecture" link works
  • "MCP Integration" link works
  • "Universal Skills" link works
  • All other links work
  • Creator attribution visible

Universal-Architecture Page:

  • Links to MCP-Integration work
  • Links to Universal-Skills work
  • Links to Home work
  • Creator attribution visible

MCP-Integration Page:

  • Links to Universal-Architecture work
  • Links to Universal-Skills work
  • Links to Installation work
  • External GitHub links work
  • Creator attribution visible

Universal-Skills Page:

  • Links to MCP-Integration work
  • Links to Universal-Architecture work
  • Links to Home work
  • Creator attribution visible

Installation Page:

  • Links to MCP-Integration work
  • Links to Universal-Skills work
  • Links to Universal-Architecture work
  • Creator attribution visible

FAQ Page:

  • Links to new pages work
  • Creator section visible
  • Creator attribution visible

Sidebar:

  • All new links present
  • All links work
  • Order correct

Footer:

  • Shows v2.1.0
  • Creator attribution visible
  • All links work

SEO Verification

Check Each Page Has:

Home:

  • Keywords in first paragraph: ai memory, claude, cursor, mcp-server, local-first
  • "Alternative to Mem0, Zep" mentioned
  • Creator name in multiple places

Universal-Architecture:

  • Keywords: universal architecture, system design, mcp protocol
  • 7-layer architecture clearly explained
  • Creator attribution at bottom

MCP-Integration:

  • Keywords: mcp-server, claude-desktop, cursor-ide, universal-integration
  • 11+ IDEs listed
  • Clear setup instructions

Universal-Skills:

  • Keywords: agent-skills, slash-commands, ai-skills
  • 6 skills documented
  • Usage examples clear

Installation:

  • v2.1.0 features mentioned
  • IDE support listed
  • Testing instructions included

FAQ:

  • v2.1.0 section present
  • Creator section present
  • MCP questions answered

Common Issues & Fixes

Links Not Working

Problem: [[Page-Name]] links show as broken

Fix:

  • Ensure page name matches exactly (case-sensitive)
  • No extra spaces
  • Use hyphens, not spaces: [[Universal-Architecture]] not [[Universal Architecture]]

Formatting Issues

Problem: Code blocks or tables render incorrectly

Fix:

  • Ensure proper markdown syntax
  • Code blocks need language hints: bash not just
  • Tables need proper header separators

Images Not Showing

Problem: Image links broken (when you add images later)

Fix:

  • Upload images to wiki
  • Use relative paths: ![alt text](image.png)
  • Or use full GitHub URLs

Sidebar Not Updating

Problem: Sidebar changes don't appear

Fix:

  • Clear browser cache
  • Hard refresh (Cmd+Shift+R or Ctrl+Shift+R)
  • Check if editing the correct _Sidebar page

Optional Enhancements

Add Images

Screenshot Locations Needed:

  1. Installation.md - "Screenshots" section (line ~250)

    • SuperLocalMemory in Claude Desktop
    • SuperLocalMemory in Cursor
    • SuperLocalMemory in Windsurf
  2. MCP-Integration.md - IDE-specific sections

    • MCP settings in each IDE
    • Tools list in AI panels
  3. Universal-Skills.md - Usage examples

    • Skills in Claude Code
    • Skills in Continue.dev
    • Skills in Cody

How to Add:

  1. Take screenshots
  2. Upload to wiki (click "Upload files")
  3. Add to pages: ![Description](filename.png)

Update README.md

After wiki deployment, update main README.md:

## πŸ“š Documentation
Visit our **[comprehensive wiki](https://github.com/qualixar/superlocalmemory/wiki)** with v2.1.0 documentation:
- [Getting Started](https://github.com/qualixar/superlocalmemory/wiki/Installation)
- [MCP Integration](https://github.com/qualixar/superlocalmemory/wiki/MCP-Integration) - Setup for 11+ IDEs
- [Universal Skills](https://github.com/qualixar/superlocalmemory/wiki/Universal-Skills) - 6 slash-commands
- [Universal Architecture](https://github.com/qualixar/superlocalmemory/wiki/Universal-Architecture) - 7-layer system
- [FAQ](https://github.com/qualixar/superlocalmemory/wiki/FAQ)

Announce Update

GitHub Discussions:

# Wiki Updated for v2.1.0! πŸŽ‰
The SuperLocalMemory wiki has been completely updated with v2.1.0 documentation:
βœ… New: [MCP Integration Guide](wiki/MCP-Integration) - Setup for 11+ IDEs
βœ… New: [Universal Skills Guide](wiki/Universal-Skills) - 6 slash-commands
βœ… Updated: [Universal Architecture](wiki/Universal-Architecture) - Now 7 layers
βœ… Updated: All pages with v2.1.0 features
Check it out: https://github.com/qualixar/superlocalmemory/wiki

Final Checklist

  • All 8 pages deployed
  • All internal links tested
  • All external links tested
  • Sidebar updated
  • Footer updated
  • Creator attribution visible on all pages
  • SEO keywords present
  • No formatting errors
  • Images added (or "coming soon" acknowledged)
  • README.md updated with wiki links
  • Announcement posted (optional)

Deployment Complete! βœ…

Your wiki is now fully updated with v2.1.0 documentation.

Next Steps:

  1. Monitor for user feedback
  2. Add screenshots when available
  3. Update as new features are added
  4. Keep CHANGELOG.md and wiki in sync

Created by: Claude Code (Anthropic) For: Varun Pratap Bhardwaj Date: February 7, 2026

Clone this wiki locally

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /