Docs site built and working, with homepage and pricing, and everything

Author: rathboma

.gitignore

@@ -1,6 +1,7 @@
 # Compiled output
 /dist
 /build
+/site
 
 # Dependencies
 /node_modules

README.md

@@ -26,6 +26,105 @@ QueryLeaf is a library that translates SQL queries into MongoDB commands. It par
   - GROUP BY with aggregation functions (COUNT, SUM, AVG, MIN, MAX)
   - JOINs between collections
 
+## SQL to MongoDB Translation Examples
+
+QueryLeaf translates SQL queries into MongoDB commands. Here are some examples of the translation:
+
+### Basic SELECT with WHERE
+
+**SQL:**
+```sql
+SELECT name, email FROM users WHERE age > 21
+```
+
+**MongoDB:**
+```js
+db.collection('users').find(
+  { age: { $gt: 21 } }, 
+  { name: 1, email: 1 }
+)
+```
+
+### Nested Field Access
+
+**SQL:**
+```sql
+SELECT name, address.city, address.zip FROM users WHERE address.city = 'New York'
+```
+
+**MongoDB:**
+```js
+db.collection('users').find(
+  { 'address.city': 'New York' }, 
+  { name: 1, 'address.city': 1, 'address.zip': 1 }
+)
+```
+
+### Array Element Access
+
+**SQL:**
+```sql
+SELECT _id, items[0].name, items[0].price FROM orders WHERE items[0].price > 1000
+```
+
+**MongoDB:**
+```js
+db.collection('orders').find(
+  { 'items.0.price': { $gt: 1000 } }, 
+  { _id: 1, 'items.0.name': 1, 'items.0.price': 1 }
+)
+```
+
+### GROUP BY with Aggregation
+
+**SQL:**
+```sql
+SELECT status, COUNT(*) as count, SUM(total) as total_amount FROM orders GROUP BY status
+```
+
+**MongoDB:**
+```js
+db.collection('orders').aggregate([
+  { 
+    $group: {
+      _id: "$status",
+      status: { $first: "$status" },
+      count: { $sum: 1 },
+      total_amount: { $sum: "$total" }
+    }
+  }
+])
+```
+
+### JOIN Between Collections
+
+**SQL:**
+```sql
+SELECT u.name, o._id as order_id, o.total FROM users u JOIN orders o ON u._id = o.userId
+```
+
+**MongoDB:**
+```js
+db.collection('users').aggregate([
+  {
+    $lookup: {
+      from: "orders",
+      localField: "_id",
+      foreignField: "userId",
+      as: "orders"
+    }
+  },
+  { $unwind: { path: "$orders", preserveNullAndEmptyArrays: true } },
+  {
+    $project: {
+      name: 1,
+      order_id: "$orders._id",
+      total: "$orders.total"
+    }
+  }
+])
+```
+
 ## Installation
 
 ```bash
@@ -93,7 +192,59 @@ npm run example
 ts-node src/examples/dummy-client-demo.ts
 ```
 
-This example demonstrates:
+## SQL Query Examples
+
+Here are some practical SQL queries you can use with QueryLeaf:
+
+### Working with Nested Fields
+
+```sql
+-- Query users by nested address field
+SELECT name, email, address.city FROM users WHERE address.zip = '10001'
+
+-- Insert with nested document structure
+INSERT INTO users (name, age, email, address) VALUES 
+('Jane Smith', 28, 'jane@example.com', {
+  "street": "456 Park Ave",
+  "city": "Chicago",
+  "state": "IL",
+  "zip": "60601"
+})
+
+-- Update a nested field
+UPDATE users SET address.city = 'San Francisco', address.state = 'CA' WHERE _id = '123'
+```
+
+### Working with Array Fields
+
+```sql
+-- Query by array element property
+SELECT userId, total FROM orders WHERE items[0].name = 'Laptop'
+
+-- Filter by array element condition
+SELECT * FROM orders WHERE items[1].price < 50
+
+-- Insert document with array field
+INSERT INTO orders (userId, items, status) VALUES
+('user123', [
+  { "id": "prod1", "name": "Monitor", "price": 300 },
+  { "id": "prod2", "name": "Keyboard", "price": 75 }
+], 'pending')
+```
+
+### Advanced Queries
+
+```sql
+-- Using GROUP BY with aggregation functions
+SELECT category, COUNT(*) as count, AVG(price) as avg_price FROM products GROUP BY category
+
+-- JOIN between users and orders
+SELECT u.name, o.total, o.status FROM users u JOIN orders o ON u._id = o.userId WHERE o.total > 100
+```
+
+Check out the [examples folder](src/examples/) for more complete examples, including how to set up the QueryLeaf instance and execute these queries.
+
+This library demonstrates:
 - Basic SELECT queries
 - Filtering with WHERE clauses
 - Sorting with ORDER BY
@@ -105,7 +256,7 @@ This example demonstrates:
 
 ## Architecture
 
-Squongo follows a modular architecture:
+QueryLeaf follows a modular architecture:
 
 1. **SqlParser**: Converts SQL text into an abstract syntax tree (AST) using node-sql-parser
 2. **SqlCompiler**: Transforms the AST into MongoDB commands
@@ -122,9 +273,11 @@ The project includes both unit tests and integration tests:
 Run unit tests with:
 
 ```bash
-npm test
+npm run test:unit
 ```
 
+Unit tests are located in the `tests/unit` directory and focus on testing the parsing and compilation of SQL statements without requiring a database connection.
+
 #### Integration Tests
 
 Integration tests use [testcontainers](https://github.com/testcontainers/testcontainers-node) to spin up a MongoDB instance in Docker. Make sure you have Docker installed and running before executing these tests.
@@ -135,13 +288,21 @@ Run integration tests with:
 npm run test:integration
 ```
 
+Integration tests are located in the `tests/integration` directory and test the complete functionality with a real MongoDB database.
+
 These tests will:
 1. Start a MongoDB container
 2. Load fixture data
 3. Run a series of SQL queries against the database
 4. Verify the results
 5. Clean up the container when done
 
+To run all tests:
+
+```bash
+npm run test:all
+```
+
 ### Continuous Integration
 
 This project uses GitHub Actions for continuous integration. The CI workflow automatically runs on:
@@ -151,12 +312,33 @@ This project uses GitHub Actions for continuous integration. The CI workflow aut
 The CI workflow:
 1. Sets up Node.js (versions 16.x, 18.x, and 20.x)
 2. Installs dependencies
-3. Runs all tests (including integration tests with MongoDB in a Docker container)
-4. Performs type checking
-5. Builds the package
+3. Runs unit tests
+4. Runs integration tests with MongoDB in a Docker container
+5. Performs type checking
+6. Builds the package
 
 You can see the workflow configuration in `.github/workflows/test.yml`.
 
+## Documentation
+
+Comprehensive documentation is available at [queryleaf.com/docs](https://queryleaf.com/docs), including:
+
+- Detailed installation and setup guides
+- In-depth explanation of supported SQL syntax
+- Usage examples and best practices
+- Troubleshooting and debugging guides
+- Performance optimization tips
+
+For local development, you can run the documentation site with:
+
+```bash
+# Install required packages
+pip install -r requirements.txt
+
+# Serve the documentation locally
+npm run docs:serve
+```
+
 ## License
 
 QueryLeaf is dual-licensed:

docs/README.md

@@ -0,0 +1,88 @@
+# QueryLeaf Documentation
+
+This directory contains the source files for the QueryLeaf documentation site. The documentation is built using [MkDocs](https://www.mkdocs.org/) with the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
+
+## Viewing the Documentation
+
+You can view the documentation in several ways:
+
+1. **Online**: Visit the published documentation at [queryleaf.com/docs](https://queryleaf.com/docs)
+
+2. **Locally**: Run the documentation server locally with:
+   ```bash
+   npm run docs:serve
+   ```
+   Then open your browser to [http://localhost:8000](http://localhost:8000)
+
+## Documentation Structure
+
+The documentation is organized as follows:
+
+- `index.md`: Home page
+- `getting-started/`: Installation and quickstart guides
+- `usage/`: Core concepts and usage examples
+- `sql-syntax/`: Detailed SQL syntax reference
+- `debugging/`: Troubleshooting and limitations
+- `licenses/`: License information
+- `assets/`: Images and other static assets
+- `stylesheets/`: Custom CSS styles
+
+## Contributing to the Documentation
+
+We welcome contributions to improve the documentation. Follow these steps:
+
+1. Make your changes to the Markdown files in this directory
+2. Run `npm run docs:serve` to preview your changes locally
+3. Once you're satisfied, submit a pull request with your changes
+
+## Building the Documentation
+
+To build a static version of the documentation:
+
+```bash
+npm run docs:build
+```
+
+This will generate a `site` directory containing the static HTML, CSS, and JavaScript files.
+
+## Deploying the Documentation
+
+To deploy the documentation to GitHub Pages:
+
+```bash
+npm run docs:deploy
+```
+
+This will build the documentation and deploy it to the `gh-pages` branch of the repository.
+
+## Documentation Technology
+
+- [MkDocs](https://www.mkdocs.org/): The documentation site generator
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/): The theme for the documentation
+- [Python-Markdown](https://python-markdown.github.io/): The Markdown parser
+- [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/): Extensions for Python-Markdown
+
+## Local Development Setup
+
+To set up the documentation development environment:
+
+1. Install Python 3.x
+2. Install MkDocs and all required packages using the requirements.txt file:
+   ```bash
+   pip install -r ../requirements.txt
+   ```
+
+## Documentation Guidelines
+
+When contributing to the documentation, please follow these guidelines:
+
+1. Use clear, concise language
+2. Include code examples where appropriate
+3. Follow the existing structure and formatting
+4. Test your changes locally before submitting
+5. Use proper Markdown syntax and formatting
+6. Include screenshots or diagrams for complex concepts when helpful
+
+## License
+
+The documentation is licensed under the same terms as the QueryLeaf project.