This directory contains the official website, landing page, and developer documentation for BitBuilder Hypervisor.

website/
├── index.html          # Landing page
├── docs.html           # Getting started documentation
├── architecture.html   # Architecture documentation
├── stack.html          # Stack & templates documentation
├── api.html            # API reference
├── css/
│   ├── styles.css      # Main stylesheet
│   └── docs.css        # Documentation-specific styles
└── js/
    ├── main.js         # Main JavaScript
    └── docs.js         # Documentation enhancements

• Modern, responsive design
• Hero section with key messaging
• Benefits and features showcase
• Core technologies overview
• Architecture highlights
• UAPI compliance information
• Call-to-action sections

• Getting Started (docs.html) - Installation, quick start, core concepts
• Architecture (architecture.html) - System architecture, design decisions, patterns
• Stack & Templates (stack.html) - Template system, extension images, examples
• API Reference (api.html) - Varlink API documentation

• ✅ Responsive design for mobile, tablet, and desktop
• ✅ Smooth scrolling and animations
• ✅ Sidebar navigation for documentation
• ✅ Code syntax highlighting
• ✅ Copy-to-clipboard for code blocks
• ✅ Anchor links for headings
• ✅ Print-friendly styles
• ✅ SEO optimized

• Any modern web browser
• A local web server (optional, for development)

cd website
python3 -m http.server 8000
# Open http://localhost:8000 in your browser

cd website
npx http-server -p 8000
# Open http://localhost:8000 in your browser

Simply open index.html in your web browser. Note that some features may not work correctly without a web server.

The website is configured for GitHub Pages deployment. To deploy:

1. Ensure the website/ directory is in your repository
2. Go to repository Settings > Pages
3. Set the source to the branch containing this website
4. Configure the directory to /website
5. Save and wait for deployment

Alternatively, you can use GitHub Actions for automated deployment (see .github/workflows/ if configured).

To deploy to any web server:

1. Copy the entire website/ directory to your web server
2. Configure your web server to serve index.html as the default document
3. Ensure proper MIME types for CSS and JS files
4. Optional: Enable gzip compression for better performance

No build step is required! The website is pure HTML, CSS, and JavaScript.

Edit css/styles.css and modify the CSS variables in :root:

:root {
    --primary-color: #2563eb;
    --secondary-color: #7c3aed;
    --accent-color: #f59e0b;
    --dark-bg: #0f172a;
    --light-bg: #f8fafc;
    /* ... */
}

• Landing Page: Edit index.html
• Documentation: Edit docs.html, architecture.html, stack.html, api.html
• Navigation: Update navbar in each HTML file
• Footer: Update footer section in each HTML file

• Main Styles: css/styles.css - Navigation, hero, sections, footer
• Documentation Styles: css/docs.css - Documentation layout, sidebar, content

• Desktop: > 968px
• Tablet: 768px - 968px
• Mobile: < 768px

Before deploying, test the following:

1. Navigation: All links work correctly
2. Responsive Design: Test on mobile, tablet, and desktop
3. Code Blocks: Copy-to-clipboard functionality works
4. Anchor Links: Section anchors scroll correctly
5. External Links: GitHub and other external links are correct
6. Print: Documentation prints correctly

When updating documentation:

1. Use Semantic HTML: Proper heading hierarchy (h1 > h2 > h3)
2. Code Examples: Wrap in <pre><code> tags
3. Info Boxes: Use .info-box or .warning-box classes
4. Tables: Use .docs-table class for proper styling
5. Navigation: Update sidebar navigation to match new sections

• Chrome/Edge: Latest 2 versions
• Firefox: Latest 2 versions
• Safari: Latest 2 versions
• Mobile browsers: iOS Safari, Chrome Android

The website content and code are part of BitBuilder Hypervisor and are licensed under the MIT License.

To contribute to the website:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: This website!

Future enhancements:

• Search functionality
• Dark mode toggle
• Interactive architecture diagrams
• API playground/sandbox
• Video tutorials
• Multi-language support
• Blog/news section

Built with ❤️ for the BitBuilder Hypervisor project.