Skip to content

Commit 7eb3794

Browse files
Merge pull request #2 from intuit/oss-updates
Jekyll theme to just-the-docs & 'Why Infigraph' section
2 parents 4108b67 + 061ad63 commit 7eb3794

7 files changed

Lines changed: 195 additions & 186 deletions

File tree

.github/workflows/pages.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ jobs:
5252
echo "---"
5353
echo "layout: default"
5454
echo "title: $(extract_title ARCHITECTURE.md)"
55+
echo "nav_order: 3"
5556
echo "---"
5657
echo ""
5758
cat ARCHITECTURE.md
@@ -62,6 +63,7 @@ jobs:
6263
echo "---"
6364
echo "layout: default"
6465
echo "title: $(extract_title CONTRIBUTING.md)"
66+
echo "nav_order: 4"
6567
echo "---"
6668
echo ""
6769
cat CONTRIBUTING.md
@@ -72,6 +74,7 @@ jobs:
7274
echo "---"
7375
echo "layout: default"
7476
echo "title: Getting Started"
77+
echo "nav_order: 2"
7578
echo "---"
7679
echo ""
7780
echo "# Getting Started with Infigraph"

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,41 @@ AI agents are **structurally blind** to your codebase. When they need to answer
1616

1717
**The cost:** 60–80% of AI agent tokens spent on code rediscovery instead of solving your problem.
1818

19+
## Why Infigraph (What Makes It Unique)
20+
21+
The market has two categories of solutions — neither solves this:
22+
23+
**Cloud-based tools** (GitHub Copilot, Sourcegraph, Codeium, Tabnine):
24+
- ❌ Require sending your code to external APIs
25+
- ❌ Expensive per-query (token costs compound)
26+
- ❌ Latency-bound by network round-trips
27+
- ❌ Privacy concerns for proprietary code
28+
- ✅ Good AI integration
29+
30+
**Local analysis tools** (ctags, Language Servers, ripgrep, CodeQL):
31+
- ✅ Run locally, offline-capable
32+
- ✅ No privacy/security concerns
33+
- ❌ No persistent knowledge graph
34+
- ❌ Limited language support (1-3 languages)
35+
- ❌ Not designed for AI agents
36+
- ❌ Scattered results, high token overhead for agents
37+
38+
**The gap Infigraph fills:**
39+
| Feature | Cloud Tools | Local Tools | Infigraph |
40+
|---------|-------------|------------|-----------|
41+
| **Local-first operation** ||||
42+
| **Persistent knowledge graph** ||||
43+
| **62 language support** ||||
44+
| **AI agent integration** (MCP) | Limited |||
45+
| **Offline operation** ||||
46+
| **No external APIs** ||||
47+
| **Cypher queries on code** ||||
48+
| **Cross-file resolution** || Limited ||
49+
50+
**No other product or OSS combines all of these.** Infigraph is the first AI-native, local-first knowledge graph engine for code.
51+
52+
---
53+
1954
## The Solution
2055

2156
Infigraph builds a **persistent knowledge graph** of your codebase before the agent runs. Structural questions that would cost hundreds of tokens to answer with raw file reads now resolve in milliseconds:
@@ -39,14 +74,17 @@ Examples:
3974

4075
## Table of Contents
4176

77+
- [The Problem](#the-problem) — What Infigraph solves
78+
- [Why Infigraph](#why-infigraph-what-makes-it-unique) — Unique market position
79+
- [The Solution](#the-solution) — How it works
4280
- [Key Highlights](#key-highlights) — Core capabilities at a glance
4381
- [Quick Start](#quick-start) — Install and run in 2 minutes
4482
- [How It Works](#how-it-works) — Integration with AI coding agents
4583
- [Offline-First Design](#offline-first-design) — No APIs, no network calls
4684
- [Installation](#installation) — Setup for all platforms
4785
- [Usage Examples](#usage-examples) — CLI commands, Web UI, tasks
4886
- [Features & Architecture](#features--architecture) — Full capabilities list
49-
- [Supported Languages](#supported-languages-62) — All 62 languages
87+
- [Supported Languages (62)](#supported-languages-62) — All 62 languages
5088
- [Contributing](#contributing) — Build from source, add languages, contribute
5189
- [License](#license)
5290

docs/Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
source "https://rubygems.org"
22

33
gem "jekyll", "~> 4.3"
4-
gem "jekyll-theme-minimal"
4+
gem "just-the-docs"
55
gem "jekyll-seo-tag"
66
gem "kramdown-parser-gfm"
77
gem "rouge"

docs/README.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Infigraph Documentation
22

3-
This directory contains the source for the Infigraph documentation site, built with Jekyll and deployed to GitHub Pages.
3+
This directory contains the source for the Infigraph documentation site, built with [Just the Docs](https://just-the-docs.github.io/) theme and deployed to GitHub Pages.
44

55
## Local Development
66

@@ -36,46 +36,65 @@ Output goes to `docs/_site/`
3636

3737
```
3838
docs/
39-
├── _config.yml Jekyll configuration
40-
├── assets/
41-
│ └── css/style.scss Custom stylesheet
42-
├── index.md Landing page
43-
├── getting-started.md Getting started guide
44-
├── architecture.md Architecture & design document
45-
├── contributing.md Contributing guidelines
46-
└── Gemfile Ruby dependencies
39+
├── _config.yml Jekyll configuration (Just the Docs theme)
40+
├── index.md Landing page (nav_order: 1)
41+
├── getting-started.md Getting started (auto-generated, nav_order: 2)
42+
├── architecture.md Architecture (auto-generated, nav_order: 3)
43+
├── contributing.md Contributing (auto-generated, nav_order: 4)
44+
├── Gemfile Ruby dependencies
45+
└── README.md This file
4746
```
4847

48+
**Auto-generated files** (derived from root sources):
49+
- `getting-started.md` — Extracted from README.md Quick Start section
50+
- `architecture.md` — Auto-generated from ARCHITECTURE.md
51+
- `contributing.md` — Auto-generated from CONTRIBUTING.md
52+
53+
These files are in `.gitignore` and regenerated on every deployment.
54+
4955
## Adding a New Page
5056

5157
1. Create a new `.md` file in the `docs/` directory
52-
2. Add YAML frontmatter:
58+
2. Add YAML frontmatter with nav_order:
5359
```yaml
5460
---
5561
layout: default
5662
title: Page Title
63+
nav_order: 5
5764
---
5865
```
5966
3. Write content in Markdown
60-
4. Link from other pages using `[text](/infigraph/page-slug)`
67+
4. Links use Jekyll's `link` filter: `[text]({% link page.md %})`
6168

6269
## Deployment
6370

64-
Documentation is automatically deployed to GitHub Pages when changes are pushed to `main` (triggered by updates to `docs/**` files).
71+
Documentation is automatically deployed to GitHub Pages when changes are pushed to `main`:
72+
- Triggers on: changes to `docs/**`, `ARCHITECTURE.md`, `CONTRIBUTING.md`, or `.github/workflows/pages.yml`
73+
- Workflow: `.github/workflows/pages.yml`
74+
- Site URL: https://intuit.github.io/infigraph/
75+
76+
## Theme Configuration
6577

66-
Site URL: https://intuit.github.io/infigraph/
78+
Uses [Just the Docs](https://just-the-docs.github.io/) — professional documentation theme with:
79+
- Sidebar navigation
80+
- Built-in search
81+
- Dark/light mode toggle
82+
- Mobile responsive design
83+
- Syntax highlighting
6784

68-
## Theme
85+
To customize:
86+
- Edit `_config.yml` for site metadata, color scheme, and navigation links
87+
- Theme styling is built-in; no custom CSS needed
6988

70-
Uses [jekyll-theme-minimal](https://github.com/pages-themes/minimal) with custom styling in `assets/css/style.scss`.
89+
## Single Source of Truth Pattern
7190

72-
To modify the theme:
73-
- Edit `_config.yml` for site metadata and navigation
74-
- Edit `assets/css/style.scss` for styling
75-
- Modify layouts in `_includes/` or `_layouts/` (copied from theme)
91+
README.md is the source of truth. Jekyll pages derive from it:
92+
- Root `README.md` → docs pages via auto-generation
93+
- No duplication: pages are ephemeral, regenerated on every build
94+
- Edit root sources; Jekyll updates automatically
7695

7796
## References
7897

98+
- [Just the Docs Documentation](https://just-the-docs.github.io/)
7999
- [Jekyll Documentation](https://jekyllrb.com/docs/)
80100
- [GitHub Pages with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll)
81-
- [Minimal Theme](https://pages-themes.github.io/minimal/)

docs/_config.yml

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
title: Infigraph
2-
description: AST-powered code intelligence engine
2+
description: AST-powered Local-first Code Intelligence Engine
33
url: https://intuit.github.io/infigraph
44
baseurl: /infigraph
55

6-
theme: jekyll-theme-minimal
6+
# Theme: Just the Docs (professional documentation theme)
7+
theme: just-the-docs
78
plugins:
89
- jekyll-seo-tag
910

10-
# Navigation
11-
nav:
12-
- text: Home
13-
url: /
14-
- text: Getting Started
15-
url: /getting-started
16-
- text: Architecture
17-
url: /architecture
18-
- text: Contributing
19-
url: /contributing
20-
- text: GitHub
21-
url: https://github.com/intuit/infigraph
11+
# Just the Docs configuration
12+
color_scheme: light
13+
search_enabled: true
14+
search_tokenizer_separator: /[\s/]+/
15+
heading_anchors: true
16+
17+
# Navigation (sidebar)
18+
aux_links:
19+
"GitHub": https://github.com/intuit/infigraph
20+
"License": https://github.com/intuit/infigraph/blob/main/LICENSE
21+
aux_links_new_tab: true
22+
23+
# Footer
24+
footer_content: "Built with ❤️ by <a href=\"https://intuit.com\">Intuit</a> • <a href=\"https://github.com/intuit/infigraph/blob/main/LICENSE\">Apache 2.0</a>"
2225

2326
# Site metadata
2427
author:
@@ -31,6 +34,8 @@ repository: intuit/infigraph
3134
markdown: kramdown
3235
kramdown:
3336
syntax_highlighter: rouge
37+
input: GFM
38+
hard_wrap: false
3439

3540
# Exclude from build
3641
exclude:

docs/assets/css/style.scss

Lines changed: 0 additions & 113 deletions
This file was deleted.

0 commit comments

Comments
 (0)