Wiki Management Guide
Wiki Management Guide
Overview
This directory (technical-documentation) is the central wiki for all AI assistants (Claude, Kiro, etc.) working on BlueFly.io projects.
GitLab Wiki: https://gitlab.com/groups/blueflyio/agent-platform/-/wikis/home
Architecture
- TypeScript Service: Type-safe sync with Zod validation
- Conflict Detection: Stops on merge conflicts, requires manual resolution
- Automated Sync: Every 15 minutes via launchd (macOS) or GitLab CI
Setup
1. Install Dependencies
npm install
2. Install Local Sync (macOS)
cp com.blueflyio.wiki-sync.plist ~/Library/LaunchAgents/ launchctl load ~/Library/LaunchAgents/com.blueflyio.wiki-sync.plist
3. GitLab Scheduled Pipeline (Already Configured)
Scheduled in gitlab_components project:
- URL: https://gitlab.com/blueflyio/agent-platform/gitlab_components/-/pipeline_schedules
- Uses component:
automation/wiki-sync.yml - Runs every 15 minutes
- Clones wiki, runs
npm run sync
Manual Sync
npm run sync
Conflict Resolution
If sync detects conflicts:
- Service exits with error
- Manually resolve conflicts in repo
- Commit resolution
- Next sync will proceed normally
Adding Other Wikis as Submodules
git submodule add https://gitlab.com/org/project.wiki.git wikis/project-name git commit -m "Add project-name wiki as submodule" git push origin main
For AI Assistants
This wiki is the source of truth for all BlueFly.io projects.