You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: stop duplicating the command table and quick-start in README (#403)
The README and the docs site were both carrying the same content:
* The 100-row **Available Commands** table lived in README.md *and* in
`docs/guide/commands.md` (auto-generated with far more detail:
summary / aliases / usage / subcommands / examples per command).
* The **Quick start** snippet and **Unified syntax** note lived in
README.md *and* in `docs/guide/quickstart.md`.
* The README **Features** bullets restated what `docs/index.md` already
says under "Why ggc?".
* The **References** heading was accidentally present twice after the
last slim pass.
Trim the README to the things only the repo front page needs to do:
badges, demo GIFs, a one-paragraph overview, an install snippet, and
links into the docs site for everything else. Drop the duplicated
feature bullets, command table, quick-start block, and unified-syntax
note; they're all a click away.
Rewire the generator to match:
* `tools/cmd/gendocs/main.go` no longer touches `README.md`. It only
emits `docs/guide/commands.md`. All the README-scanning helpers
(findCommandSection, findCommandTable, writeUpdatedREADME, etc.) go
away.
* `Makefile`'s `docs` target updates its log line accordingly.
Net: README 218 -> 88 lines; gendocs 300 -> ~130 lines; nothing the
docs site already covers is lost.
Copy file name to clipboardExpand all lines: README.md
+8-139Lines changed: 8 additions & 139 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,18 +32,16 @@ Click any GIF to view full size.
32
32
33
33
ggc is a Git tool written in Go, offering both a traditional CLI and an interactive TUI with incremental search and multi-command workflows. Run `ggc <subcommand>` directly, or type `ggc` on its own to open the fuzzy picker.
34
34
35
-
Full docs: **<https://bmf-san.github.io/ggc/>**
35
+
Supported: macOS (amd64 / arm64 / universal), Linux (amd64 / arm64), Windows (amd64). Requires Git and Go 1.25+ to build.
36
36
37
-
## Features
37
+
Full documentation lives at **<https://bmf-san.github.io/ggc/>**:
38
38
39
-
-**Flagless CLI** — every command is verb + words (`ggc branch delete merged`, `ggc commit amend no-edit`). No `-m`/`--flag` juggling.
40
-
-**Interactive mode** — fuzzy-search every command, pipe commands into workflows with <kbd>Tab</kbd>, and run the pipeline with <kbd>Ctrl</kbd>+<kbd>T</kbd>.
41
-
-**Pickers when arguments are omitted** — `ggc branch checkout`, `ggc stash pop`, `ggc restore` all prompt for the target.
42
-
-**Composite helpers** — `ggc pull rebase`, `ggc push force`, `ggc rebase autosquash`, `ggc fetch prune`, and more.
43
-
-**User aliases** — define simple or multi-step aliases in `~/.config/ggc/config.yaml`.
@@ -60,135 +58,6 @@ go install github.com/bmf-san/ggc/v8@latest
60
58
61
59
Windows binaries, pre-built archives, and source builds are covered in the [installation guide](https://bmf-san.github.io/ggc/guide/install/). After installing, run `ggc doctor` to verify.
62
60
63
-
## Quick start
64
-
65
-
```bash
66
-
ggc status # working tree status
67
-
ggc add .# stage everything
68
-
ggc commit "fix: off-by-one"# no -m required
69
-
ggc log graph # prettier git log
70
-
ggc branch checkout # list + pick a local branch
71
-
ggc rebase interactive # interactive rebase
72
-
```
73
-
74
-
Run `ggc` with no arguments to enter interactive mode. See the [quick start](https://bmf-san.github.io/ggc/guide/quickstart/) and [interactive mode guide](https://bmf-san.github.io/ggc/guide/interactive/) for more.
75
-
76
-
### Unified syntax and `--` separator
77
-
78
-
ggc uses a flagless, space-separated syntax. To pass a literal that starts with `-`, use the standard `--` separator:
79
-
80
-
```bash
81
-
ggc commit -- - fix leading dash
82
-
```
83
-
84
-
Everything after `--` is treated as data, never as subcommands.
0 commit comments