docpact 0.1.0

Deterministic documentation governance CLI for AI-assisted software teams.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# docpact

`docpact` is a Rust-first standalone CLI for diff-driven AI documentation drift checks.

It is meant to be installed as a CLI and used in local workflows and CI.

Current distribution status:

- not published to crates.io yet
- usable today via `cargo run` or `cargo install --path .`
- intended future distribution: published crate and release binaries

## Quick Start

Install from source for now:

```bash
cargo install --path .
```

Create `.docpact/config.yaml` in the target repository, then run:

```bash
docpact validate-config --root /path/to/repo
docpact validate-config --root /path/to/repo --strict
docpact lint --root /path/to/repo --files src/api/client.ts,README.md
```

For a full setup guide, start with [../docs/README.md](../docs/README.md).

## Document Map

- [../docs/README.md](../docs/README.md) / [../docs/README.zh-CN.md](../docs/README.zh-CN.md): documentation hub and reading guide
- [../docs/installation.md](../docs/installation.md) / [../docs/installation.zh-CN.md](../docs/installation.zh-CN.md): how to install or run the CLI today
- [../docs/usage.md](../docs/usage.md) / [../docs/usage.zh-CN.md](../docs/usage.zh-CN.md): quick start, commands, diff modes, outputs, and local workflow
- [../docs/configuration.md](../docs/configuration.md) / [../docs/configuration.zh-CN.md](../docs/configuration.zh-CN.md): detailed config reference and rule behavior
- [../docs/github-actions.md](../docs/github-actions.md) / [../docs/github-actions.zh-CN.md](../docs/github-actions.zh-CN.md): GitHub Actions integration examples
- [../docs/product-vision.md](../docs/product-vision.md) / [../docs/product-vision.zh-CN.md](../docs/product-vision.zh-CN.md): product positioning, scope, and roadmap
- [../docs/roadmap.md](../docs/roadmap.md) / [../docs/roadmap.zh-CN.md](../docs/roadmap.zh-CN.md): staged delivery plan, coverage milestones, and priorities
- [../docs/features.md](../docs/features.md) / [../docs/features.zh-CN.md](../docs/features.zh-CN.md): current capabilities, limitations, and implementation notes
- [examples/workspace-config.yaml](./examples/workspace-config.yaml): standalone reference snippet for a workspace `config.yaml`
- [examples/repo-config.yaml](./examples/repo-config.yaml): standalone reference snippet for a repo `config.yaml`

The new project also standardizes on one reserved config entrypoint:

- `.docpact/config.yaml`

## Current State

This repository currently contains a working Phase 1 core:

- changed-path collection from explicit files or git diff sources
- workspace/repo impact-rule loading
- trigger-to-required-doc matching
- key Markdown and YAML metadata checks
- warning vs blocking exit behavior
- text and JSON-capable reporting surfaces

It is not yet the full planned product. Higher-order drift detection, autofix, richer config validation, an official GitHub Action wrapper, and published package distribution remain future work.