Files
aitbc/website/README.md.example
oib 07f3a87328 docs: restructure website, optimize HTML, gitignore private files
Website docs (website/docs/):
- Delete 6 stale -md.html duplicates
- Rename docs-clients/miners/developers → clients/miners/developers.html
- Unify header/nav across all 15 pages (new .site-header pattern)
- Fix 34 dead href=# links with real targets
- Upgrade Font Awesome v4→v6 in index.html
- Replace search stub with live client-side search (15-page index)
- Extract all inline CSS into shared docs.css (+630 lines)
- Extract inline theme JS into shared theme.js
- Strip inline style= attributes from 10+ pages
- Add .announce-banner, .source-links, .search-results CSS classes
- Add Markdown Source links to clients/miners/developers pages
- Update components.html title to Architecture & Components
- Move browser-wallet.html to website/wallet/, leave redirect
- Update all dates to February 2026

Website root:
- Delete 6 root-level duplicate HTML files (160KB saved)
- Rewire index.html and 404.html links

Root README.md:
- Fix 8 broken doc links to new numbered folder structure
- Update copyright to 2026

.gitignore + .example files:
- Gitignore private files: .aitbc.yaml, .env, deploy scripts,
  GPU scripts, service scripts, infra configs, .windsurf/, website README
- Create 7 .example files for GitHub users with sanitized templates
- Untrack 47 previously committed private files

Live server:
- Push all website files to aitbc-cascade:/var/www/html/
- Clean stale admin.html and index.nginx-debian.html
2026-02-13 23:18:52 +01:00

55 lines
2.1 KiB
Plaintext

# AITBC Website
Production website for the AITBC platform.
## File Structure
```
website/
├── index.html # Homepage — platform overview & achievements
├── 404.html # Custom error page
├── aitbc-proxy.conf # Nginx reverse proxy configuration
├── favicon.svg
├── font-awesome-local.css
├── docs/ # All documentation (16 pages)
│ ├── index.html # Docs landing — search, reader-level cards
│ ├── clients.html # Client guide — jobs, wallet, pricing, API
│ ├── miners.html # Miner guide — GPU setup, earnings, Ollama
│ ├── developers.html # Developer guide — SDKs, contributing, bounties
│ ├── full-documentation.html # Complete technical reference
│ ├── components.html # Architecture & components overview
│ ├── flowchart.html # End-to-end system flow diagram
│ ├── api.html # REST API reference
│ ├── blockchain-node.html
│ ├── coordinator-api.html
│ ├── explorer-web.html
│ ├── marketplace-web.html
│ ├── wallet-daemon.html
│ ├── trade-exchange.html
│ ├── pool-hub.html
│ ├── browser-wallet.html # Redirect → /wallet/
│ ├── css/docs.css # Shared stylesheet
│ └── js/theme.js # Dark/light theme toggle
└── wallet/
└── index.html # Browser wallet landing page
```
## Deployment
Copy the website files to your web server's document root:
```bash
# Example using scp (replace with your server details)
scp -r website/* your-server:/var/www/html/
```
## Key Features
- **Unified header/nav** across all 15 doc pages with theme toggle
- **Live search** on docs index (client-side, 15-page index)
- **Shared CSS** — zero inline `<style>` blocks, one `docs.css`
- **Shared JS** — theme persistence via `theme.js`
- **Zero dead links** — all `href="#"` replaced with real targets
- **Font Awesome 6** consistently across all pages
- **Dark/light mode** with localStorage persistence