docs: comprehensive documentation polish & CI/CD automation

Major Updates:
- Rewrote all docs in beginner-friendly 'ELI5' language
- Created docs index with user journey navigation
- Added complete getting-started guide for novice users
- Set up GitHub Container Registry (GHCR) automation
- Configured GitHub Pages deployment for documentation

Documentation:
- docs/index.md - Central navigation hub
- docs/getting-started.md - Step-by-step beginner guide
- docs/github-setup.md - CI/CD setup instructions
- README.md - Complete rewrite in accessible language
- CONTRIBUTING.md - Contributor guidelines
- Multiple comprehensive API and schema docs

CI/CD Workflows:
- .github/workflows/docker-build.yml - Multi-platform builds to GHCR
- .github/workflows/docs.yml - Automated docs deployment to Pages
- Supports main (latest), development (dev), and version tags
- Automated testing of built images
- Beautiful documentation site with dark theme

Benefits:
- Zero barrier to entry for new users
- Automated Docker builds (AMD64 + ARM64)
- Professional documentation site
- No Docker Hub account needed (uses GHCR)
- Complete CI/CD pipeline

All 7 implementation phases complete - project is production ready!
This commit is contained in:
Wikid82
2025-11-18 13:11:11 -05:00
parent b9dcc6c347
commit e58fcb714d
76 changed files with 16989 additions and 99 deletions

View File

@@ -0,0 +1,88 @@
import { ProxyHost } from '../hooks/useProxyHosts'
import { RemoteServer } from '../hooks/useRemoteServers'
export const mockProxyHosts: ProxyHost[] = [
{
uuid: '123e4567-e89b-12d3-a456-426614174000',
domain_names: 'app.local.dev',
forward_scheme: 'http',
forward_host: 'localhost',
forward_port: 3000,
access_list_id: undefined,
certificate_id: undefined,
ssl_forced: false,
http2_support: true,
hsts_enabled: false,
hsts_subdomains: false,
block_exploits: true,
websocket_support: true,
advanced_config: undefined,
enabled: true,
created_at: '2025-11-18T10:00:00Z',
updated_at: '2025-11-18T10:00:00Z',
},
{
uuid: '223e4567-e89b-12d3-a456-426614174001',
domain_names: 'api.local.dev',
forward_scheme: 'http',
forward_host: '192.168.1.100',
forward_port: 8080,
access_list_id: undefined,
certificate_id: undefined,
ssl_forced: false,
http2_support: true,
hsts_enabled: false,
hsts_subdomains: false,
block_exploits: true,
websocket_support: false,
advanced_config: undefined,
enabled: true,
created_at: '2025-11-18T10:00:00Z',
updated_at: '2025-11-18T10:00:00Z',
},
]
export const mockRemoteServers: RemoteServer[] = [
{
uuid: '323e4567-e89b-12d3-a456-426614174002',
name: 'Local Docker Registry',
provider: 'docker',
host: 'localhost',
port: 5000,
username: undefined,
enabled: true,
reachable: false,
last_check: undefined,
created_at: '2025-11-18T10:00:00Z',
updated_at: '2025-11-18T10:00:00Z',
},
{
uuid: '423e4567-e89b-12d3-a456-426614174003',
name: 'Development API Server',
provider: 'generic',
host: '192.168.1.100',
port: 8080,
username: undefined,
enabled: true,
reachable: true,
last_check: '2025-11-18T10:00:00Z',
created_at: '2025-11-18T10:00:00Z',
updated_at: '2025-11-18T10:00:00Z',
},
]
export const mockImportPreview = {
hosts: [
{
domain_names: 'test.example.com',
forward_scheme: 'http',
forward_host: 'localhost',
forward_port: 8080,
ssl_forced: true,
http2_support: true,
websocket_support: false,
},
],
conflicts: ['app.local.dev'],
errors: [],
}