WIKI SETUP GUIDE

GitHub Wiki Setup Guide for BMLibrarian

Quick Setup (Recommended)

Step 1: Initialize Wiki on GitHub

1. Visit https://github.com/hherb/bmlibrarian/wiki
2. Click "Create the first page"
3. Enter Home as the title
4. Add any placeholder content (will be replaced)
5. Click "Save Page"

Step 2: Run the Population Script

cd /tmp/wiki_content
./populate_wiki.sh

The script will automatically:

• Clone the wiki repository
• Copy all 42 documentation pages
• Set up navigation (Home, Sidebar, Footer)
• Commit and push to GitHub

Step 3: View Your Wiki

Visit: https://github.com/hherb/bmlibrarian/wiki

---

Manual Setup (Alternative)

If you prefer manual control:

# 1. Clone the wiki repository (after initializing on GitHub)
git clone https://github.com/hherb/bmlibrarian.wiki.git
cd bmlibrarian.wiki

# 2. Copy all documentation
cp /tmp/wiki_content/*.md .

# 3. Commit and push
git add .
git commit -m "Add comprehensive documentation to wiki"
git push origin master

---

What's Included

Navigation

• Home.md - Main landing page with full documentation index
• _Sidebar.md - Navigation menu (appears on all pages)
• _Footer.md - Footer links (appears on all pages)

User Documentation (18 pages)

• Getting Started
• CLI Guide
• Research GUI Guide
• Config GUI Guide
• Configuration Guide
• Workflow Guide
• Agents Guide
• Query Agent Guide
• Citation Guide
• Reporting Guide
• Counterfactual Guide
• Multi-Model Query Guide
• Queue Management Guide
• Migration System
• CLI Reference
• Troubleshooting
• And more...

Developer Documentation (22 pages)

• Architecture Overview
• Agents Architecture
• Agent Module
• GUI Architecture
• Modular CLI Architecture
• Workflow System
• Queue System Architecture
• Citation System
• Reporting System
• Counterfactual System
• Multi-Model Architecture
• Human Edit Logging
• Unified Document Card
• API Reference
• Contributing Guide
• And more...

Total: 42 documentation pages

---

Keeping Wiki Updated

To update the wiki when documentation changes:

# From your bmlibrarian repository
cd /tmp/wiki_content

# Copy updated docs
cp ~/src/bmlibrarian/doc/users/*.md .
cp ~/src/bmlibrarian/doc/developers/*.md .

# Push to wiki
cd ~/src/bmlibrarian.wiki
cp /tmp/wiki_content/*.md .
git add .
git commit -m "Update documentation"
git push origin master

---

Troubleshooting

"Repository not found" error

• Cause: Wiki hasn't been initialized on GitHub yet
• Solution: Follow Step 1 above to create the first page

"Permission denied" error

• Cause: Not authenticated with GitHub
• Solution: Ensure you're logged in with gh auth login

Pages not showing up

• Cause: File names must match wiki page titles
• Solution: GitHub wiki converts filenames: Getting-Started.md → "Getting Started" page

Sidebar not appearing

• Cause: Sidebar filename must be exactly _Sidebar.md
• Solution: Check filename capitalization

---

Wiki Maintenance

Adding New Pages

1. Create New-Page.md in wiki repository
2. Add link to _Sidebar.md for navigation
3. Commit and push

Updating Existing Pages

1. Edit the .md file
2. Commit and push
3. Changes appear immediately

Linking Between Pages

Use double brackets: [[Page Name]] or [[Page-Name]]

---

Notes

• GitHub wikis are separate git repositories (.wiki.git)
• Wiki pages use GitHub Flavored Markdown
• Images can be uploaded through the web interface
• Wiki pages are searchable through GitHub's wiki search
• All edits are version controlled with git history

---

Ready to populate your wiki? Run ./populate_wiki.sh now!