Skip to content

Commit 1e89d95

Browse files
Copilotdanielbodnar
Copilot
and
danielbodnar
authored
Add website, landing page, and developer documentation (#3)
* Initial plan * Add landing page, documentation site structure, and styles Co-authored-by: danielbodnar <1790726+danielbodnar@users.noreply.github.com> * Add complete website with architecture, stack, and API documentation pages Co-authored-by: danielbodnar <1790726+danielbodnar@users.noreply.github.com> * Add GitHub Actions workflow for website deployment and update README Co-authored-by: danielbodnar <1790726+danielbodnar@users.noreply.github.com> * docs: normalize fenced codeblock language tags (remove extra spaces for proper syntax highlighting) (#4) --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: danielbodnar <1790726+danielbodnar@users.noreply.github.com>
1 parent 14ec67c commit 1e89d95

13 files changed

Lines changed: 4122 additions & 0 deletions

File tree

‎.github/workflows/deploy-website.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy Website to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'website/**'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
deploy:
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
30+
- name: Setup Pages
31+
uses: actions/configure-pages@v4
32+
33+
- name: Upload artifact
34+
uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: './website'
37+
38+
- name: Deploy to GitHub Pages
39+
id: deployment
40+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
> **🔥 A revolutionary git-ops-based, multi-tenant hypervisor platform built on systemd technologies for secure, isolated, and declaratively managed virtualization environments.**
1515
16+
📖 **[Visit the Website & Documentation →](website/index.html)**
17+
1618
------------------------------------------------------------------------
1719

1820
## 🌟 Overview

‎website/.nojekyll‎

Whitespace-only changes.

‎website/README.md‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
# BitBuilder Hypervisor Website
2+
3+
This directory contains the official website, landing page, and developer documentation for BitBuilder Hypervisor.
4+
5+
## 📁 Structure
6+
7+
```
8+
website/
9+
├── index.html # Landing page
10+
├── docs.html # Getting started documentation
11+
├── architecture.html # Architecture documentation
12+
├── stack.html # Stack & templates documentation
13+
├── api.html # API reference
14+
├── css/
15+
│ ├── styles.css # Main stylesheet
16+
│ └── docs.css # Documentation-specific styles
17+
└── js/
18+
├── main.js # Main JavaScript
19+
└── docs.js # Documentation enhancements
20+
```
21+
22+
## 🚀 Features
23+
24+
### Landing Page (`index.html`)
25+
- Modern, responsive design
26+
- Hero section with key messaging
27+
- Benefits and features showcase
28+
- Core technologies overview
29+
- Architecture highlights
30+
- UAPI compliance information
31+
- Call-to-action sections
32+
33+
### Documentation Site
34+
- **Getting Started** (`docs.html`) - Installation, quick start, core concepts
35+
- **Architecture** (`architecture.html`) - System architecture, design decisions, patterns
36+
- **Stack & Templates** (`stack.html`) - Template system, extension images, examples
37+
- **API Reference** (`api.html`) - Varlink API documentation
38+
39+
### Features
40+
- ✅ Responsive design for mobile, tablet, and desktop
41+
- ✅ Smooth scrolling and animations
42+
- ✅ Sidebar navigation for documentation
43+
- ✅ Code syntax highlighting
44+
- ✅ Copy-to-clipboard for code blocks
45+
- ✅ Anchor links for headings
46+
- ✅ Print-friendly styles
47+
- ✅ SEO optimized
48+
49+
## 🛠️ Development
50+
51+
### Prerequisites
52+
- Any modern web browser
53+
- A local web server (optional, for development)
54+
55+
### Running Locally
56+
57+
#### Option 1: Python HTTP Server
58+
```bash
59+
cd website
60+
python3 -m http.server 8000
61+
# Open http://localhost:8000 in your browser
62+
```
63+
64+
#### Option 2: Node.js HTTP Server
65+
```bash
66+
cd website
67+
npx http-server -p 8000
68+
# Open http://localhost:8000 in your browser
69+
```
70+
71+
#### Option 3: Direct File Access
72+
Simply open `index.html` in your web browser. Note that some features may not work correctly without a web server.
73+
74+
## 📦 Deployment
75+
76+
### GitHub Pages
77+
78+
The website is configured for GitHub Pages deployment. To deploy:
79+
80+
1. Ensure the `website/` directory is in your repository
81+
2. Go to repository Settings > Pages
82+
3. Set the source to the branch containing this website
83+
4. Configure the directory to `/website`
84+
5. Save and wait for deployment
85+
86+
Alternatively, you can use GitHub Actions for automated deployment (see `.github/workflows/` if configured).
87+
88+
### Custom Hosting
89+
90+
To deploy to any web server:
91+
92+
1. Copy the entire `website/` directory to your web server
93+
2. Configure your web server to serve `index.html` as the default document
94+
3. Ensure proper MIME types for CSS and JS files
95+
4. Optional: Enable gzip compression for better performance
96+
97+
### Configuration
98+
99+
No build step is required! The website is pure HTML, CSS, and JavaScript.
100+
101+
## 🎨 Customization
102+
103+
### Colors
104+
105+
Edit `css/styles.css` and modify the CSS variables in `:root`:
106+
107+
```css
108+
:root {
109+
--primary-color: #2563eb;
110+
--secondary-color: #7c3aed;
111+
--accent-color: #f59e0b;
112+
--dark-bg: #0f172a;
113+
--light-bg: #f8fafc;
114+
/* ... */
115+
}
116+
```
117+
118+
### Content
119+
120+
- **Landing Page**: Edit `index.html`
121+
- **Documentation**: Edit `docs.html`, `architecture.html`, `stack.html`, `api.html`
122+
- **Navigation**: Update navbar in each HTML file
123+
- **Footer**: Update footer section in each HTML file
124+
125+
### Styling
126+
127+
- **Main Styles**: `css/styles.css` - Navigation, hero, sections, footer
128+
- **Documentation Styles**: `css/docs.css` - Documentation layout, sidebar, content
129+
130+
## 📱 Responsive Breakpoints
131+
132+
- **Desktop**: > 968px
133+
- **Tablet**: 768px - 968px
134+
- **Mobile**: < 768px
135+
136+
## 🧪 Testing
137+
138+
Before deploying, test the following:
139+
140+
1. **Navigation**: All links work correctly
141+
2. **Responsive Design**: Test on mobile, tablet, and desktop
142+
3. **Code Blocks**: Copy-to-clipboard functionality works
143+
4. **Anchor Links**: Section anchors scroll correctly
144+
5. **External Links**: GitHub and other external links are correct
145+
6. **Print**: Documentation prints correctly
146+
147+
## 📝 Content Guidelines
148+
149+
When updating documentation:
150+
151+
1. **Use Semantic HTML**: Proper heading hierarchy (h1 > h2 > h3)
152+
2. **Code Examples**: Wrap in `<pre><code>` tags
153+
3. **Info Boxes**: Use `.info-box` or `.warning-box` classes
154+
4. **Tables**: Use `.docs-table` class for proper styling
155+
5. **Navigation**: Update sidebar navigation to match new sections
156+
157+
## 🔧 Browser Support
158+
159+
- Chrome/Edge: Latest 2 versions
160+
- Firefox: Latest 2 versions
161+
- Safari: Latest 2 versions
162+
- Mobile browsers: iOS Safari, Chrome Android
163+
164+
## 📄 License
165+
166+
The website content and code are part of BitBuilder Hypervisor and are licensed under the MIT License.
167+
168+
## 🤝 Contributing
169+
170+
To contribute to the website:
171+
172+
1. Fork the repository
173+
2. Create a feature branch
174+
3. Make your changes
175+
4. Test thoroughly
176+
5. Submit a pull request
177+
178+
## 📞 Support
179+
180+
- **Issues**: [GitHub Issues](https://github.com/bitbuilder-io/bitbuilder-hypervisor/issues)
181+
- **Discussions**: [GitHub Discussions](https://github.com/bitbuilder-io/bitbuilder-hypervisor/discussions)
182+
- **Documentation**: This website!
183+
184+
## 🗺️ Roadmap
185+
186+
Future enhancements:
187+
188+
- [ ] Search functionality
189+
- [ ] Dark mode toggle
190+
- [ ] Interactive architecture diagrams
191+
- [ ] API playground/sandbox
192+
- [ ] Video tutorials
193+
- [ ] Multi-language support
194+
- [ ] Blog/news section
195+
196+
---
197+
198+
Built with ❤️ for the BitBuilder Hypervisor project.

0 commit comments

Comments
 (0)