|
| 1 | +# GitHub Wiki Setup Instructions |
| 2 | + |
| 3 | +The development documentation has been prepared and is ready to be added to GitHub Wiki. |
| 4 | + |
| 5 | +## Quick Setup (Recommended) |
| 6 | + |
| 7 | +1. **Enable Wiki** (already enabled for this repo) |
| 8 | + |
| 9 | +2. **Create Wiki pages via GitHub Web UI:** |
| 10 | + - Go to: https://github.com/m1ngsama/TNT/wiki |
| 11 | + - Click "Create the first page" |
| 12 | + - Title: `Home` |
| 13 | + - Content: Copy from `README.md` (project overview) |
| 14 | + - Click "Save Page" |
| 15 | + |
| 16 | +3. **Add Development Guide:** |
| 17 | + - Click "New Page" |
| 18 | + - Title: `Development-Guide` |
| 19 | + - Content: Copy from `docs/Development-Guide.md` |
| 20 | + - Click "Save Page" |
| 21 | + |
| 22 | +4. **Add other pages as needed:** |
| 23 | + - Contributing Guide (from `docs/CONTRIBUTING.md`) |
| 24 | + - Deployment Guide (from `docs/DEPLOYMENT.md`) |
| 25 | + - Security Reference (from `docs/SECURITY_QUICKREF.md`) |
| 26 | + - Quick Reference (from `docs/QUICKREF.md`) |
| 27 | + |
| 28 | +## Alternative: Clone and Push |
| 29 | + |
| 30 | +Once the Wiki has at least one page, you can manage it via git: |
| 31 | + |
| 32 | +```sh |
| 33 | +# Clone wiki repository |
| 34 | +git clone https://github.com/m1ngsama/TNT.wiki.git |
| 35 | +cd TNT.wiki |
| 36 | + |
| 37 | +# Copy documentation |
| 38 | +cp ../docs/Development-Guide.md ./Development-Guide.md |
| 39 | +cp ../docs/CONTRIBUTING.md ./Contributing.md |
| 40 | +cp ../docs/DEPLOYMENT.md ./Deployment.md |
| 41 | + |
| 42 | +# Commit and push |
| 43 | +git add . |
| 44 | +git commit -m "docs: add development documentation" |
| 45 | +git push origin master |
| 46 | +``` |
| 47 | + |
| 48 | +## Wiki Page Structure |
| 49 | + |
| 50 | +Recommended structure: |
| 51 | + |
| 52 | +``` |
| 53 | +Home - Project overview (from README.md) |
| 54 | +├── Development-Guide - Complete dev manual |
| 55 | +├── Contributing - How to contribute |
| 56 | +├── Deployment - Production deployment |
| 57 | +├── Security-Reference - Security configuration |
| 58 | +└── Quick-Reference - Command cheat sheet |
| 59 | +``` |
| 60 | + |
| 61 | +## Notes |
| 62 | + |
| 63 | +- GitHub Wiki uses its own git repository (separate from main repo) |
| 64 | +- Wiki pages are written in Markdown |
| 65 | +- Page titles become URLs (spaces → hyphens) |
| 66 | +- First page must be created via Web UI |
| 67 | +- After that, you can use git to manage content |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +**All documentation is already in `docs/` directory and can be viewed directly in the repository.** |
0 commit comments