Skip to content

Commit 061ad63

Browse files
Fix README TOC and update Jekyll docs guide
README.md fixes: - Update Table of Contents to include missing sections: * Add 'The Problem' section * Add 'The Solution' section - Fix anchor for 'Supported Languages (62)' (was just '62') docs/README.md updates: - Replace jekyll-theme-minimal references with just-the-docs - Document auto-generated files (getting-started, architecture, contributing) - Explain single source of truth pattern - Update theme customization instructions - Update structure and references - Add proper nav_order guidance for new pages Cleanup: - Remove empty docs/assets/css directory (not needed with just-the-docs) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
1 parent 600eeb7 commit 061ad63

2 files changed

Lines changed: 43 additions & 22 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,17 @@ Examples:
7474

7575
## Table of Contents
7676

77-
- [Why Infigraph](#why-infigraph-what-makes-it-unique) — What's unique in the market
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
7880
- [Key Highlights](#key-highlights) — Core capabilities at a glance
7981
- [Quick Start](#quick-start) — Install and run in 2 minutes
8082
- [How It Works](#how-it-works) — Integration with AI coding agents
8183
- [Offline-First Design](#offline-first-design) — No APIs, no network calls
8284
- [Installation](#installation) — Setup for all platforms
8385
- [Usage Examples](#usage-examples) — CLI commands, Web UI, tasks
8486
- [Features & Architecture](#features--architecture) — Full capabilities list
85-
- [Supported Languages](#supported-languages-62) — All 62 languages
87+
- [Supported Languages (62)](#supported-languages-62) — All 62 languages
8688
- [Contributing](#contributing) — Build from source, add languages, contribute
8789
- [License](#license)
8890

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/)

0 commit comments

Comments
 (0)