quick start

Author: sjefvanleeuwen

README.md

@@ -24,9 +24,9 @@ A high-performance, embedded, GraphQL-native database engine written in C# for .
 
 ### Documentation
 
-- [**⚡ Quick Start**](docs/quick-start.md) - Get up and running in 5 minutes with Star Wars example
+- [**⚡ Quick Start**](examples/StarWars/quick-start.md) - Get up and running in 5 minutes with Star Wars example
 - [Getting Started Guide](docs/getting-started.md) - Installation and quick start tutorials
-- [**Filtering & Sorting Guide**](docs/filtering-guide.md) - Prisma-style filtering, sorting, pagination with examples
+- [**Filtering & Sorting Guide**](examples/StarWars/filtering-guide.md) - Prisma-style filtering, sorting, pagination with Star Wars examples
 - [Features](docs/features.md) - Schema-driven development, GraphQL support, storage engine
 - [Configuration](docs/configuration.md) - Database configuration and settings
 - [API Reference](docs/api-reference.md) - Complete API documentation

docs/filtering-guide.md examples/StarWars/filtering-guide.mddocs/filtering-guide.md renamed to examples/StarWars/filtering-guide.md

@@ -1,7 +1,9 @@
-# SharpGraph Filtering & Sorting Guide
+# 🎬 SharpGraph Filtering & Sorting Guide - Star Wars Examples
 
 Complete guide to Prisma-style filtering, sorting, and pagination in SharpGraph.
 
+**All examples use the Star Wars GraphQL Database** with 6 entity types: Character, Film, Planet, Species, Starship, and Vehicle.
+
 ## Table of Contents
 
 1. [Connection Pattern](#connection-pattern)

docs/quick-start.md examples/StarWars/quick-start.mddocs/quick-start.md renamed to examples/StarWars/quick-start.md

@@ -1,6 +1,8 @@
-# 🚀 SharpGraph Quick Start Guide
+# 🚀 SharpGraph Quick Start - Star Wars Example
 
-Get started with SharpGraph in 5 minutes: seed the Star Wars database and start querying!
+Get started with SharpGraph in 5 minutes using the Star Wars database: seed data and start querying!
+
+All examples in this guide use the **Star Wars GraphQL Database** with 30+ characters, 8 films, planets, species, starships, and vehicles.
 
 ## Prerequisites
 
@@ -36,7 +38,18 @@ dotnet build
 
 ## Step 3: Start the GraphQL Server
 
-The SharpGraph server runs on `http://localhost:8080` and automatically loads the Star Wars schema with seed data.
+The SharpGraph server automatically loads the Star Wars schema and seeds the database with 30+ characters, 8 films, planets, species, starships, and vehicles.
+
+### How Seeding Works
+
+When you start the server:
+1. **Schema Load** - Reads `graphql_db/schema.graphql`
+2. **Type Generation** - Generates connection types, filter types, CRUD mutations
+3. **Seed Data** - Populates tables from `examples/StarWars/seed_data.json`
+4. **Index Creation** - Creates indexes for fast lookups
+5. **Server Ready** - Listens on `http://localhost:8080`
+
+All seed data is stored in binary format in the `graphql_db/` folder and persists between restarts.
 
 ### Option A: Using PowerShell script (easiest)
 
@@ -46,6 +59,10 @@ The SharpGraph server runs on `http://localhost:8080` and automatically loads th
 
 # You should see:
 # 🚀 SharpGraph Server starting...
+# ✅ Schema loaded from graphql_db/schema.graphql
+# ✅ Seeding database with Star Wars data...
+# ✅ Character table: 30+ characters loaded
+# ✅ Film table: 8 films loaded
 # ✅ Server is ready at http://127.0.0.1:8080
 # 📊 Introspection available at http://127.0.0.1:8080/__schema
 ```
@@ -61,12 +78,14 @@ dotnet watch run --project src/SharpGraph.Server/SharpGraph.Server.csproj
 ```
 
 The server will:
-✅ Load `graphql_db/schema.graphql`  
+✅ Load `graphql_db/schema.graphql` with Star Wars types  
+✅ Seed database with 30+ characters from `seed_data.json`  
 ✅ Generate connection types (CharacterConnection, FilmConnection, etc.)  
-✅ Auto-generate CRUD mutations  
+✅ Auto-generate CRUD mutations (create, update, delete)  
+✅ Create indexes for fast lookups
 ✅ Make schema available for introspection  
 
-**Keep this terminal open** - your server is now running!
+**Keep this terminal open** - your server is now running with Star Wars data ready to query!
 
 ## Step 4: Test with Your First Query
 
@@ -403,14 +422,14 @@ $query = @'
 ## Next Steps
 
 ### 📖 Learn More
-- **[filtering-guide.md](filtering-guide.md)** - Complete filtering and sorting reference
-- **[README.md](../README.md)** - Architecture and features overview
-- **[examples/StarWars/README.md](../examples/StarWars/README.md)** - Star Wars schema details
+- **[filtering-guide.md](filtering-guide.md)** - Complete filtering and sorting reference with Star Wars queries
+- **[README.md](../../README.md)** - Architecture and features overview
+- **[README.md](README.md)** - Star Wars schema details
 
 ### 🔧 Advanced Topics
-- [SCHEMA_DRIVEN_FEATURE.md](../SCHEMA_DRIVEN_FEATURE.md) - Schema-driven development
-- [INDEXING-TESTS-SUMMARY.md](../INDEXING-TESTS-SUMMARY.md) - Indexing strategy
-- [OPTIMIZATIONS.md](../OPTIMIZATIONS.md) - Performance tips
+- [SCHEMA_DRIVEN_FEATURE.md](../../SCHEMA_DRIVEN_FEATURE.md) - Schema-driven development
+- [INDEXING-TESTS-SUMMARY.md](../../INDEXING-TESTS-SUMMARY.md) - Indexing strategy
+- [OPTIMIZATIONS.md](../../OPTIMIZATIONS.md) - Performance tips
 
 ### 💡 Try Building Your Own Schema
 
@@ -444,8 +463,8 @@ input UserInput {
 
 ## Getting Help
 
-- 📝 Check the [documentation](../README.md)
-- 🐛 Review [troubleshooting guide](troubleshooting.md)
+- 📝 Check the [documentation](../../README.md)
+- 🐛 Review [troubleshooting guide](../../docs/troubleshooting.md)
 - 💬 Check GitHub issues or create a new one
 
 ## Performance Tips