Rough Draft: fulltext with sample diagrams and images

Author: codegraphtheory

README.md

@@ -1,286 +1,65 @@
-# Graph Technology Developers GitHub Pages Template (for Educational Resources)
-
-A minimal, responsive template for publishing open-source educational resources on GitHub Pages. Optimized for developer readability, SEO, and AI-agent parsing.
+# A Brief Introduction to Graph Databases
 
 [![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-enabled-blue.svg)](https://pages.github.com/)
 [![Jekyll](https://img.shields.io/badge/Jekyll-4.0+-blue.svg)](https://jekyllrb.com/)
-[![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-enabled-green.svg)](https://github.com/features/actions)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-enabled-green.svg)](https://github.com/features/actions)
 
-## Features
-
-- **Mobile-responsive design** - Works beautifully on all devices
-- **SEO optimized** - Built-in meta tags, sitemap, and semantic HTML
-- **AI-friendly structure** - Optimized for readability by AI agents
-- **Code syntax highlighting** - Support for multiple programming languages
-- **Diagram support** - Mermaid.js integration for technical visualizations
-- **Dark mode** - Automatic dark mode via `prefers-color-scheme`
-- **Minimal custom theme** - Clean, distinct styling without heavy dependencies
-- **Auto-deployment** - GitHub Actions workflow for automatic deployment
-
-## Quick Start
-
-1. **Clone or fork this repository**
-
-   ```bash
-   git clone https://github.com/GraphTechnologyDevelopers/gh-pages-template.git
-   cd gh-pages-template
-   ```
-
-2. **Update configuration**
-
-   Edit `_config.yml` and update:
-   - `title` - Your site title
-   - `description` - Site description
-   - `url` - `https://{username}.github.io` (or your custom domain)
-   - `baseurl` - `/{repository-name}` for project sites, or `""` for user/org sites
-
-3. **Customize footer links** (optional)
-
-   Edit `_includes/footer.html` to update or add footer links.
-
-4. **Add your content**
-
-   - Edit `index.md` for the homepage
-   - Add new `.md` files for additional pages
-   - Place images and assets in `assets/` directory
-
-5. **Deploy**
-
-   - Push to GitHub
-   - Enable GitHub Pages in repository Settings → Pages (select "GitHub Actions")
-   - Your site will be live at `https://{username}.github.io/{repository-name}`
-
-## Project Structure
-
-```
-.
-├── _config.yml          # Jekyll configuration
-├── _layouts/            # HTML layouts
-│   ├── default.html     # Default page layout
-│   └── page.html        # Content page layout
-├── _includes/           # Reusable components
-│   ├── head.html        # Head section with meta tags
-│   └── footer.html      # Footer with links
-├── assets/              # Static assets
-│   ├── css/
-│   │   └── styles.css   # Custom styles
-│   ├── js/
-│   │   └── main.js      # JavaScript functionality
-│   └── images/          # Image files
-├── pages/                # Additional pages
-│   └── getting-started.md
-├── index.md              # Homepage
-├── robots.txt            # SEO robots file
-├── .github/
-│   └── workflows/
-│       └── pages.yml     # GitHub Actions deployment
-└── README.md             # This file
-```
-
-## Adding Content
-
-### Creating New Pages
-
-Create new `.md` files anywhere in the repository. They'll automatically use the page layout:
-
-```markdown
----
-title: My New Page
----
-
-# My New Page
-
-Your content here...
-```
-
-### Code Blocks
-
-Use triple backticks with language identifiers:
-
-````markdown
-```python
-def hello():
-    print("Hello, World!")
-```
-````
-
-### Diagrams
-
-Use Mermaid syntax for diagrams:
-
-````markdown
-```mermaid
-graph TD
-    A[Start] --> B{Decision}
-    B -->|Yes| C[Action 1]
-    B -->|No| D[Action 2]
-```
-````
-
-### Images
-
-Place images in `assets/images/` and reference them:
-
-```markdown
-![Alt text](/assets/images/example.png)
-```
-
-## Customization
-
-### Styling
-
-Edit `assets/css/styles.css` to customize the theme. The CSS uses variables for easy customization:
-
-```css
-:root {
-  --color-bg: #ffffff;
-  --color-text: #1a1a1a;
-  --color-link: #0066cc;
-  /* ... */
-}
-```
-
-### Layouts
-
-Modify `_layouts/default.html` or `_layouts/page.html` to change page structure.
-
-### Configuration
-
-See `_config.yml` for all available configuration options. Key settings:
-
-- `title` - Site title
-- `description` - Site description for SEO
-- `url` / `baseurl` - GitHub Pages URL configuration
-- `plugins` - Jekyll plugins (SEO, sitemap)
-
-## SEO Optimization
-
-This template includes:
-
-- **jekyll-seo-tag** - Automatic meta tags, Open Graph, Twitter Cards
-- **jekyll-sitemap** - Automatic sitemap generation
-- Semantic HTML structure
-- Clean heading hierarchy
-- Mobile-friendly responsive design
-
-Add page-specific SEO in front matter:
-
-```yaml
----
-title: Page Title
-description: Page description for search engines
-keywords: keyword1, keyword2
----
-```
-
-## Deployment
-
-The GitHub Actions workflow (`/.github/workflows/pages.yml`) automatically:
-
-1. Builds the Jekyll site on push to `main`
-2. Deploys to GitHub Pages
-3. Handles dependencies and caching
-
-**No manual deployment steps needed!**
-
-To enable:
-1. Go to repository Settings → Pages
-2. Select "GitHub Actions" as the source
-3. Push to `main` branch
-
-## Local Development
-
-To test locally (requires Ruby 3.0+ and Jekyll):
-
-### Prerequisites
-
-Install Ruby 3.0 or newer. Recommended methods:
-
-**Using Homebrew (macOS):**
-```bash
-brew install ruby
-```
-
-**Using rbenv (recommended):**
-```bash
-# Install rbenv
-brew install rbenv ruby-build
-
-# Install Ruby 3.0+
-rbenv install 3.3.0
-rbenv local 3.3.0
-```
-
-**Using asdf:**
-```bash
-# Install asdf plugin
-asdf plugin add ruby
-
-# Install Ruby 3.0+
-asdf install ruby 3.3.0
-asdf local ruby 3.3.0
-```
-
-### Setup and Run
-
-```bash
-# Install dependencies (local to project, no sudo needed)
-bundle install --path vendor/bundle
+**Read the book online:** ["https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/"](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/)
 
-# Serve locally (without baseurl prefix for easier testing)
-bundle exec jekyll serve --baseurl ""
+## About This Book
 
-# Or test with baseurl to match production:
-bundle exec jekyll serve
+Graphs model the interconnected fabric of real-world data—from social ties to supply chains, biological networks to fraud patterns. Traditional databases like RDBMS handle structured rows well, but as relationships proliferate, queries bog down with expensive joins. Graph databases prioritize these connections, delivering fast traversals even in massive, evolving datasets.
 
-# Visit http://localhost:4000
-# (or http://localhost:4000/gh-pages-template if baseurl is set)
-```
+This manual expands on core concepts for developers, blending theory with practical how-tos. Expect deeper dives into modeling, querying, and implementation, with code samples in Cypher and Python, plus Mermaid diagrams for clarity. It's distilled from key sources but written briskly: why graphs outperform alternatives, how to build and query them, and tips for real apps.
 
-**Note:** 
-- The `--baseurl ""` flag allows you to test without the baseurl prefix locally
-- Use `bundle install --path vendor/bundle` to install gems locally without sudo
-- For production, GitHub Pages will handle the baseurl automatically based on your repository settings
+Data explodes, but value lies in links. Spot fraud rings via cycles; recommend via paths. Ignore graphs, and your systems miss hidden insights.
 
-## Browser Support
+## Table of Contents
 
-- Chrome (latest)
-- Firefox (latest)
-- Safari (latest)
-- Edge (latest)
+1. [Welcome to Connected Data](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/welcome-to-connected-data/)
+2. [Why Graphs Matter](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/why-graphs-matter/)
+3. [Graph Theory Primer](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/graph-theory-primer/)
+4. ["Core Concepts: Nodes and Edges"](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/core-concepts-nodes-and-edges/)
+5. [Graph Models Compared](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/graph-models-compared/)
+6. [Data Organization Techniques](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/data-organization-techniques/)
+7. ["Querying Graphs: Languages That Click"](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/querying-graphs-languages-that-click/)
+8. [Data Modeling Basics](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/data-modeling-basics/)
+9. [Data Modeling Pitfalls to Avoid](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/data-modeling-pitfalls-to-avoid/)
+10. [Why Ditch Relational for Graphs?](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/why-ditch-relational-for-graphs/)
+11. ["NoSQL Context: Where Graphs Fit"](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/nosql-context-where-graphs-fit/)
+12. [Native vs Non-Native Processing](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/native-vs-non-native-processing/)
+13. [Graph Algorithms Essentials](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/graph-algorithms-essentials/)
+14. ["Use Cases: Graphs in Action"](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/use-cases-graphs-in-action/)
+15. [Popular Graph Databases](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/popular-graph-databases/)
+16. [Distribution and Transactions](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/distribution-and-transactions/)
+17. [Future Challenges](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/future-challenges/)
+18. [Imperative vs Declarative Queries](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/imperative-vs-declarative-queries/)
+19. [Pitfalls in Graph Modeling](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/pitfalls-in-graph-modeling/)
+20. [Getting Started with Neo4j](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/getting-started-with-neo4j/)
+21. [Wrapping Up](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/wrapping-up/)
+22. [Acknowledgements](https://graphtechnologydevelopers.github.io/brief-intro-graph-databases/chapters/acknowledgements/)
 
-## Technologies Used
+## Community & Resources
 
-- [Jekyll](https://jekyllrb.com/) - Static site generator
-- [GitHub Pages](https://pages.github.com/) - Hosting
-- [GitHub Actions](https://github.com/features/actions) - CI/CD
-- [Mermaid.js](https://mermaid.js.org/) - Diagram rendering
-- [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) - SEO optimization
-- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) - Sitemap generation
+- [Graph Technology Developers GitHub Org](https://github.com/GraphTechnologyDevelopers)
+- [Graph Technology Developers Community Hub](https://graphtech.dev/)
+- [Graph Technology Developers X Community](https://x.com/i/communities/1977449294861881612)
+- [CodeGraphTheory on GitHub](https://github.com/codegraphtheory)
+- [CodeGraph on X](http://x.com/codegraph)
+- [GraphTheory on X](http://x.com/graphtheory)
 
 ## License
 
-This template is available as open source under the MIT License.
+This book is available as open source under the MIT License.
 
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
 
-## Links
-
-- [Graph Technology Developers GitHub Org](https://github.com/GraphTechnologyDevelopers)
-- [Graph Technology Developers Community Hub](https://graphtech.dev/)
-- [Graph Technology Developers X Community](https://x.com/i/communities/1977449294861881612)
-- [CodeGraphTheory on GitHub](https://github.com/codegraphtheory)
-- [CodeGraph on X](http://x.com/codegraph)
-- [GraphTheory on X](http://x.com/graphtheory)
-
 ## Support
 
 For issues or questions:
-
 - Open an issue in this repository
 - Visit [Graph Technology Developers](https://graphtech.dev/)
 - Join the [X community](https://x.com/i/communities/1977449294861881612)
-

_chapters/acknowledgements.md

@@ -0,0 +1,10 @@
+---
+title: Acknowledgements
+order: 22
+---
+
+This manual draws from:
+- *Demystifying Graph Databases: Analysis and Taxonomy of Data Organization, System Designs, and Graph Queries* by Maciej Besta, Robert Gerstenberger, Emanuel Peter, Marc Fischer, Michał Podstawski, Claude Barthels, Gustavo Alonso, and Torsten Hoefler (ACM Computing Surveys, 2023).
+- *Graph Databases for Beginners* by Bryce Merkl Sasaki, Joy Chao, and Rachel Howard (Neo4j, Inc.).
+- *Graph Databases* by Prad Nelluru, Bharat Naik, Evan Liu, and Bon Koo.
+- *Graph Databases: New Opportunities for Connected Data* (2nd Edition) by Ian Robinson, Jim Webber, and Emil Eifrem (O'Reilly Media, 2015).