Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs-website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/dist/
/resources/
/.hugo_build.lock
40 changes: 40 additions & 0 deletions docs-website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Docs website

Public user documentation built with Hugo and Hextra. Independent of the
application; existing `docs/` remains code and contributor documentation.

## Run locally

From the repository root, with mise installed and the project trusted:

```sh
mise run docs:dev
```

Open <http://localhost:1313/>. Changes reload automatically; stop with `Ctrl+C`.
Mise installs the pinned Hugo extended binary when needed. The theme is pinned
in this directory's `go.mod` and `go.sum`; its first download needs network access.
The website needs Go and Git for Hugo modules, with no Node dependencies.

## Build

```sh
mise run docs:build
```

Static HTML and assets go to `docs-website/dist/` (gitignored). Build warnings
fail the command. `mise run docs:check` runs the same validation.

The pnpm workspace also exposes `pnpm --filter @diffx/docs dev`, `build`, and
`check` through mise. Application builds remain independent.

## Edit

- Homepage: `content/_index.md`.
- Guides: Markdown files in `content/`; use `weight` to order the sidebar.
- Screenshots and other assets: add files under `static/`, then reference them
with paths such as `/images/review.png`.
- Site configuration: `hugo.yaml`.

Use Hextra's built-in docs layout, search, code blocks, and theme toggle. Keep
pages brief; no custom layout or deployment setup yet.
17 changes: 17 additions & 0 deletions docs-website/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: diffx documentation
type: docs
---

Review Git changes in your browser with diffx. Read diffs, mark files reviewed,
and leave comments without changing your working tree or index.

## Start here

[Get started](getting-started/) with installation and your first local review.

## Your review workflow

- Compare branch changes, staged changes, and unstaged changes.
- Review a captured snapshot at your own pace.
- Keep comments and review progress across restarts.
42 changes: 42 additions & 0 deletions docs-website/content/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Getting started
description: Install diffx and open your first local review.
weight: 1
---

## Install

With Homebrew:

```sh
brew install flexdinesh/tap/diffx
```

Or with Go 1.25 or later:

```sh
go install github.com/flexdinesh/diffx/cmd/diffx@latest
```

## Open a review

From your Git repository, run:

```sh
diffx
```

Your browser opens the captured changes. Use the file list to navigate, switch
between all, staged, and unstaged changes, and add comments as you review.

To review another repository:

```sh
diffx /path/to/repo
```

## Capture new changes

A review is a fixed snapshot. After editing your code, stop diffx with `Ctrl+C`
and run it again to capture the latest changes. Comments and review progress
persist across restarts.
5 changes: 5 additions & 0 deletions docs-website/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/flexdinesh/diffx/docs-website

go 1.25.0

require github.com/imfing/hextra v0.13.0 // indirect
2 changes: 2 additions & 0 deletions docs-website/go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github.com/imfing/hextra v0.13.0 h1:1zhCYy0tA9ZRErFBlU6NJEgR1HjK69bgd52EmpwnG00=
github.com/imfing/hextra v0.13.0/go.mod h1:vi+yhpq8YPp/aghvJlNKVnJKcPJ/VyAEcfC1BSV9ARo=
39 changes: 39 additions & 0 deletions docs-website/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
baseURL: http://localhost:1313/
locale: en-US
title: diffx
publishDir: dist

module:
imports:
- path: github.com/imfing/hextra

menu:
main:
- name: Documentation
pageRef: /
weight: 1
- name: Search
weight: 2
params:
type: search
- name: GitHub
url: https://github.com/flexdinesh/diffx
weight: 3
params:
icon: github

params:
description: Review Git changes in your browser with diffx.
navbar:
displayTitle: true
displayLogo: false
theme:
default: system
displayToggle: true
footer:
displayCopyright: false
displayPoweredBy: true

markup:
highlight:
noClasses: false
9 changes: 9 additions & 0 deletions docs-website/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "@diffx/docs",
"private": true,
"scripts": {
"dev": "mise run docs:dev",
"build": "mise run docs:build",
"check": "mise run docs:check"
}
}
13 changes: 13 additions & 0 deletions mise.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ run = "pnpm dev:web"
description = "Build self-contained agent plugin adapters"
run = "pnpm --recursive --filter '@diffx/plugin-*' --if-present build"

[tasks."docs:dev"]
description = "Serve the docs website with live reload at localhost:1313"
dir = "{{config_root}}/docs-website"
tools = { "hugo-extended" = "0.166.0" }
run = "hugo server --bind 127.0.0.1 --buildDrafts --disableFastRender --renderToMemory"

[tasks."docs:build"]
description = "Build and validate the static docs website at docs-website/dist"
alias = "docs:check"
dir = "{{config_root}}/docs-website"
tools = { "hugo-extended" = "0.166.0" }
run = "hugo --minify --panicOnWarning --cleanDestinationDir"

[tasks."dev:server"]
description = "Start a standalone Go fixture server"
depends = ["web:build"]
Expand Down
2 changes: 2 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
packages:
- apps/*
- packages/*
- docs-website

catalog:
"@opencode/plugin": 2.0.22
Expand Down
Loading