|
1 | 1 | # Infigraph Documentation |
2 | 2 |
|
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. |
4 | 4 |
|
5 | 5 | ## Local Development |
6 | 6 |
|
@@ -36,46 +36,65 @@ Output goes to `docs/_site/` |
36 | 36 |
|
37 | 37 | ``` |
38 | 38 | 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 |
47 | 46 | ``` |
48 | 47 |
|
| 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 | + |
49 | 55 | ## Adding a New Page |
50 | 56 |
|
51 | 57 | 1. Create a new `.md` file in the `docs/` directory |
52 | | -2. Add YAML frontmatter: |
| 58 | +2. Add YAML frontmatter with nav_order: |
53 | 59 | ```yaml |
54 | 60 | --- |
55 | 61 | layout: default |
56 | 62 | title: Page Title |
| 63 | + nav_order: 5 |
57 | 64 | --- |
58 | 65 | ``` |
59 | 66 | 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 %})` |
61 | 68 |
|
62 | 69 | ## Deployment |
63 | 70 |
|
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 |
65 | 77 |
|
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 |
67 | 84 |
|
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 |
69 | 88 |
|
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 |
71 | 90 |
|
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 |
76 | 95 |
|
77 | 96 | ## References |
78 | 97 |
|
| 98 | +- [Just the Docs Documentation](https://just-the-docs.github.io/) |
79 | 99 | - [Jekyll Documentation](https://jekyllrb.com/docs/) |
80 | 100 | - [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