|
| 1 | +# How to Enable GitHub Wiki & Documentation |
| 2 | + |
| 3 | +## 🚫 Issue: "I don't see a wiki page option in GitHub" |
| 4 | + |
| 5 | +GitHub Wiki needs to be **enabled** in repository settings. Here are **3 solutions**: |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## ✅ Solution 1: Enable GitHub Wiki (Recommended) |
| 10 | + |
| 11 | +### Step-by-Step: |
| 12 | + |
| 13 | +1. **Go to Your Repository** |
| 14 | + ``` |
| 15 | + https://github.com/flowdevs-io/Recursive-Control |
| 16 | + ``` |
| 17 | + |
| 18 | +2. **Click "Settings" Tab** |
| 19 | + - Top navigation bar |
| 20 | + - Requires admin/owner permissions |
| 21 | + |
| 22 | +3. **Scroll to "Features" Section** |
| 23 | + - About halfway down the settings page |
| 24 | + - Look for checkboxes |
| 25 | + |
| 26 | +4. **Enable Wiki** |
| 27 | + - Find "Wikis" checkbox |
| 28 | + - ✅ Check the box |
| 29 | + - Wait for save (automatic) |
| 30 | + |
| 31 | +5. **Wiki Tab Appears!** |
| 32 | + - Refresh page |
| 33 | + - "Wiki" tab now visible in main navigation |
| 34 | + - Click to create first page |
| 35 | + |
| 36 | +### Publish Wiki Content: |
| 37 | + |
| 38 | +**Method A: Web Interface** |
| 39 | +``` |
| 40 | +1. Click "Wiki" tab |
| 41 | +2. Click "Create the first page" |
| 42 | +3. Title: "Home" |
| 43 | +4. Content: Copy from wiki/Home.md |
| 44 | +5. Click "Save Page" |
| 45 | +6. Repeat for other pages |
| 46 | +``` |
| 47 | + |
| 48 | +**Method B: Git Clone** |
| 49 | +```bash |
| 50 | +# Clone wiki repository |
| 51 | +git clone https://github.com/flowdevs-io/Recursive-Control.wiki.git |
| 52 | + |
| 53 | +# Copy all wiki files |
| 54 | +cp wiki/*.md Recursive-Control.wiki/ |
| 55 | + |
| 56 | +# Rename Home to match GitHub convention |
| 57 | +cd Recursive-Control.wiki |
| 58 | +mv Home.md Home.md # Already correct |
| 59 | + |
| 60 | +# Commit and push |
| 61 | +git add . |
| 62 | +git commit -m "Complete documentation wiki" |
| 63 | +git push origin master |
| 64 | +``` |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## ✅ Solution 2: Use GitHub Pages (Alternative) |
| 69 | + |
| 70 | +**I've already set this up for you!** The `docs/` folder is ready. |
| 71 | + |
| 72 | +### Step-by-Step: |
| 73 | + |
| 74 | +1. **Go to Repository Settings** |
| 75 | + ``` |
| 76 | + Settings → Pages (left sidebar) |
| 77 | + ``` |
| 78 | + |
| 79 | +2. **Configure GitHub Pages** |
| 80 | + - **Source**: Deploy from a branch |
| 81 | + - **Branch**: `main` (or `master`) |
| 82 | + - **Folder**: `/docs` |
| 83 | + - Click **Save** |
| 84 | + |
| 85 | +3. **Wait 2-3 Minutes** |
| 86 | + - GitHub builds your site |
| 87 | + - Check Actions tab for build status |
| 88 | + |
| 89 | +4. **Access Your Documentation** |
| 90 | + ``` |
| 91 | + https://flowdevs-io.github.io/Recursive-Control/ |
| 92 | + ``` |
| 93 | + |
| 94 | +### What's Already Set Up: |
| 95 | + |
| 96 | +``` |
| 97 | +docs/ |
| 98 | +├── _config.yml # Jekyll configuration ✅ |
| 99 | +├── index.md # Home page (from wiki/Home.md) ✅ |
| 100 | +├── Installation.md # Setup guide ✅ |
| 101 | +├── Getting-Started.md # Tutorial ✅ |
| 102 | +├── Multi-Agent-Architecture.md # Technical deep dive ✅ |
| 103 | +├── FAQ.md # Questions & answers ✅ |
| 104 | +├── Troubleshooting.md # Problem solving ✅ |
| 105 | +├── API-Reference.md # Developer docs ✅ |
| 106 | +├── Blog-Post-v2.0.md # v2.0 announcement ✅ |
| 107 | +├── System-Prompts-Reference.md # Prompts ✅ |
| 108 | +├── UI-Features.md # UI improvements ✅ |
| 109 | +└── UI-Redesign.md # UI redesign ✅ |
| 110 | +``` |
| 111 | + |
| 112 | +**Theme**: Cayman (beautiful, modern) |
| 113 | +**Features**: |
| 114 | +- Automatic navigation |
| 115 | +- Syntax highlighting |
| 116 | +- Mobile responsive |
| 117 | +- SEO optimized |
| 118 | + |
| 119 | +--- |
| 120 | + |
| 121 | +## ✅ Solution 3: Use README + Docs Folder (Simplest) |
| 122 | + |
| 123 | +Keep everything in the main repository with links. |
| 124 | + |
| 125 | +### Update Main README.md: |
| 126 | + |
| 127 | +Add this section: |
| 128 | + |
| 129 | +```markdown |
| 130 | +## 📚 Documentation |
| 131 | + |
| 132 | +- [Installation Guide](docs/Installation.md) |
| 133 | +- [Getting Started](docs/Getting-Started.md) |
| 134 | +- [Multi-Agent Architecture](docs/Multi-Agent-Architecture.md) |
| 135 | +- [API Reference](docs/API-Reference.md) |
| 136 | +- [FAQ](docs/FAQ.md) |
| 137 | +- [Troubleshooting](docs/Troubleshooting.md) |
| 138 | + |
| 139 | +### Reference |
| 140 | +- [Version 2.0 Blog Post](docs/Blog-Post-v2.0.md) |
| 141 | +- [System Prompts Reference](docs/System-Prompts-Reference.md) |
| 142 | +- [UI Features](docs/UI-Features.md) |
| 143 | +- [UI Redesign](docs/UI-Redesign.md) |
| 144 | +``` |
| 145 | + |
| 146 | +**Pros:** |
| 147 | +- ✅ No setup needed |
| 148 | +- ✅ Works immediately |
| 149 | +- ✅ Visible to all users |
| 150 | +- ✅ Easy to maintain |
| 151 | + |
| 152 | +**Cons:** |
| 153 | +- ❌ No wiki-style interface |
| 154 | +- ❌ No automatic navigation |
| 155 | +- ❌ Less discoverable |
| 156 | + |
| 157 | +--- |
| 158 | + |
| 159 | +## 🎯 Comparison: Which to Use? |
| 160 | + |
| 161 | +### GitHub Wiki |
| 162 | +**Best for:** Traditional wiki experience |
| 163 | +**Pros:** |
| 164 | +- Separate git repository |
| 165 | +- Wiki-style navigation |
| 166 | +- Easy for non-devs to edit |
| 167 | +- Standard GitHub feature |
| 168 | +**Cons:** |
| 169 | +- Requires enabling |
| 170 | +- Separate from main repo |
| 171 | +- Less visibility in searches |
| 172 | + |
| 173 | +### GitHub Pages |
| 174 | +**Best for:** Professional documentation site ⭐ |
| 175 | +**Pros:** |
| 176 | +- Beautiful themed website |
| 177 | +- Custom domain support |
| 178 | +- Full control over design |
| 179 | +- Great SEO |
| 180 | +- Already set up! |
| 181 | +**Cons:** |
| 182 | +- Slightly more complex |
| 183 | +- Requires Pages setup (5 minutes) |
| 184 | + |
| 185 | +### Docs Folder in Repo |
| 186 | +**Best for:** Quick and simple |
| 187 | +**Pros:** |
| 188 | +- Immediate availability |
| 189 | +- No setup |
| 190 | +- Single repository |
| 191 | +- Version controlled with code |
| 192 | +**Cons:** |
| 193 | +- Basic markdown rendering |
| 194 | +- No navigation sidebar |
| 195 | +- Manual links needed |
| 196 | + |
| 197 | +--- |
| 198 | + |
| 199 | +## 🚀 My Recommendation |
| 200 | + |
| 201 | +**Use GitHub Pages** (Solution 2) because: |
| 202 | + |
| 203 | +1. ✅ I've already set it up for you |
| 204 | +2. ✅ Professional appearance |
| 205 | +3. ✅ Automatic navigation |
| 206 | +4. ✅ Beautiful Cayman theme |
| 207 | +5. ✅ Mobile-friendly |
| 208 | +6. ✅ Takes 2 minutes to enable |
| 209 | + |
| 210 | +**Steps:** |
| 211 | +``` |
| 212 | +1. Go to: Settings → Pages |
| 213 | +2. Source: "Deploy from a branch" |
| 214 | +3. Branch: main, Folder: /docs |
| 215 | +4. Click Save |
| 216 | +5. Wait 2-3 minutes |
| 217 | +6. Visit: https://flowdevs-io.github.io/Recursive-Control/ |
| 218 | +``` |
| 219 | + |
| 220 | +**Done!** 🎉 |
| 221 | + |
| 222 | +--- |
| 223 | + |
| 224 | +## 🔧 Enabling GitHub Wiki (Detailed) |
| 225 | + |
| 226 | +### If You Don't See Settings: |
| 227 | + |
| 228 | +**Problem:** Not repository owner/admin |
| 229 | + |
| 230 | +**Solutions:** |
| 231 | +- Ask repository owner to enable |
| 232 | +- Fork repository (you'll have settings) |
| 233 | +- Use GitHub Pages or docs folder instead |
| 234 | + |
| 235 | +### If Wiki Option is Disabled: |
| 236 | + |
| 237 | +**Problem:** Organization policy or repository type |
| 238 | + |
| 239 | +**Solutions:** |
| 240 | +1. Check organization settings |
| 241 | +2. Contact org admin |
| 242 | +3. Use GitHub Pages instead |
| 243 | + |
| 244 | +### If Wiki Enable Checkbox Missing: |
| 245 | + |
| 246 | +**Problem:** Older GitHub interface or private repo restrictions |
| 247 | + |
| 248 | +**Solutions:** |
| 249 | +1. Update repository visibility settings |
| 250 | +2. Enable via GitHub API |
| 251 | +3. Use GitHub Pages as alternative |
| 252 | + |
| 253 | +--- |
| 254 | + |
| 255 | +## 📞 Quick Help |
| 256 | + |
| 257 | +### Enable Wiki Not Working? |
| 258 | +```bash |
| 259 | +# Enable via GitHub CLI (if you have gh installed) |
| 260 | +gh repo edit --enable-wiki |
| 261 | + |
| 262 | +# Or via API |
| 263 | +curl -X PATCH \ |
| 264 | + -H "Authorization: token YOUR_TOKEN" \ |
| 265 | + -H "Accept: application/vnd.github.v3+json" \ |
| 266 | + https://api.github.com/repos/flowdevs-io/Recursive-Control \ |
| 267 | + -d '{"has_wiki":true}' |
| 268 | +``` |
| 269 | + |
| 270 | +### GitHub Pages Not Building? |
| 271 | +1. Check Actions tab for errors |
| 272 | +2. Verify `docs/` folder exists |
| 273 | +3. Check `_config.yml` is valid YAML |
| 274 | +4. Make sure branch is correct (main/master) |
| 275 | + |
| 276 | +### Links Not Working? |
| 277 | +- Wiki links: Use page names without .md |
| 278 | +- GitHub Pages: Use full paths with .md (or remove for clean URLs) |
| 279 | +- Docs folder: Use relative paths with .md |
| 280 | + |
| 281 | +--- |
| 282 | + |
| 283 | +## ✅ What You Have Now |
| 284 | + |
| 285 | +**Ready to Use:** |
| 286 | +``` |
| 287 | +✅ docs/ folder with all documentation |
| 288 | +✅ _config.yml configured for GitHub Pages |
| 289 | +✅ 12 markdown files ready |
| 290 | +✅ 78,000 words of content |
| 291 | +✅ Beautiful theme selected |
| 292 | +✅ Navigation configured |
| 293 | +``` |
| 294 | + |
| 295 | +**To Publish:** |
| 296 | +``` |
| 297 | +1. Enable GitHub Pages (2 minutes) |
| 298 | + OR |
| 299 | +2. Enable Wiki and copy files (5 minutes) |
| 300 | + OR |
| 301 | +3. Use docs/ folder directly (immediate) |
| 302 | +``` |
| 303 | + |
| 304 | +--- |
| 305 | + |
| 306 | +## 🎉 Next Steps |
| 307 | + |
| 308 | +**Choose Your Method:** |
| 309 | + |
| 310 | +**Option A: GitHub Pages (Recommended)** |
| 311 | +```bash |
| 312 | +# Already done! Just enable in Settings → Pages |
| 313 | +# Result: https://flowdevs-io.github.io/Recursive-Control/ |
| 314 | +``` |
| 315 | + |
| 316 | +**Option B: GitHub Wiki** |
| 317 | +```bash |
| 318 | +# Enable in Settings → Features → Wikis ✓ |
| 319 | +# Clone wiki and copy files |
| 320 | +git clone https://github.com/flowdevs-io/Recursive-Control.wiki.git |
| 321 | +cp wiki/*.md Recursive-Control.wiki/ |
| 322 | +cd Recursive-Control.wiki && git add . && git commit -m "Docs" && git push |
| 323 | +``` |
| 324 | + |
| 325 | +**Option C: Docs Folder** |
| 326 | +```bash |
| 327 | +# Already done! Just update main README.md |
| 328 | +# Add links to docs/*.md files |
| 329 | +# Commit and push |
| 330 | +``` |
| 331 | + |
| 332 | +--- |
| 333 | + |
| 334 | +## 💡 Pro Tip |
| 335 | + |
| 336 | +**Use GitHub Pages for best results!** |
| 337 | + |
| 338 | +It gives you: |
| 339 | +- Professional documentation site |
| 340 | +- Automatic navigation |
| 341 | +- Beautiful theme |
| 342 | +- Mobile-friendly |
| 343 | +- SEO optimized |
| 344 | +- Free hosting |
| 345 | + |
| 346 | +And I've already set it all up for you! Just enable it in settings. 🚀 |
| 347 | + |
| 348 | +--- |
| 349 | + |
| 350 | +<p align="center"> |
| 351 | + <strong>Questions?</strong><br> |
| 352 | + <a href="https://discord.gg/mQWsWeHsVU">Join Discord</a> | |
| 353 | + <a href="https://github.com/flowdevs-io/Recursive-Control/issues">Report Issue</a> |
| 354 | +</p> |
0 commit comments