diff --git a/README.md b/README.md index 2b2c4eb..cc3e818 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # `git-draft(1)` [![CI](https://github.com/mtth/git-draft/actions/workflows/ci.yaml/badge.svg)](https://github.com/mtth/git-draft/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/mtth/git-draft/graph/badge.svg?token=3OTKAI0FP6)](https://codecov.io/gh/mtth/git-draft) [![Pypi badge](https://badge.fury.io/py/git-draft.svg)](https://pypi.python.org/pypi/git-draft/) > [!NOTE] -> WIP: Unstable API. +> WIP: Evolving API. ## Highlights diff --git a/docs/git-draft.adoc b/docs/git-draft.adoc index 9afdfff..a0470d8 100644 --- a/docs/git-draft.adoc +++ b/docs/git-draft.adoc @@ -1,7 +1,7 @@ ifndef::manversion[:manversion: 0.0.0] = git-draft(1) -Matthieu Monsch +Matthieu Monsch v{manversion} :doctype: manpage :manmanual: GIT-DRAFT @@ -110,30 +110,30 @@ When the working directory is clean, a single commit is created and set as the d [source] ---- -o (main, draft/123) o draft! prompt: (draft/123+, refs/drafts/123/1) +o (main, draft/123) ---- If the working directory is dirty, a sync commit is added to identify the LLM-generated changes. [source] ---- -o (main, draft/123) -o draft! sync(prompt) o draft! prompt: (draft/123+, refs/drafts/123/1) +o draft! sync(prompt) +o (main, draft/123) ---- If merging is enabled, it have both the LLM-generated changes and manual edits as parents. [source] ---- -o (main) +o Merge (draft/123, draft/123/+) |\ -| o draft! sync(prompt) -o | draft! sync(merge) | o draft! prompt: (refs/drafts/123/1) +o | draft! sync(merge) +| o draft! sync(prompt) |/ -o Merge (draft/123, draft/123/+) +o (main) ---- Otherwise, the user is free to incorporate the changes as needed. @@ -141,13 +141,13 @@ Note that the steps above can be repeated arbitrarily many times within a given [source] ---- -o (main) -|\ -| o draft! prompt: (refs/drafts/123/1) -o draft! sync(prompt) -o draft! prompt: (refs/drafts/123/2) -o (draft/123) o draft! prompt: (draft/123+, refs/drafts/123/3) +o (draft/123) +o draft! prompt: (refs/drafts/123/2) +o draft! sync(prompt) +| o draft! prompt: (refs/drafts/123/1) +|/ +o (main) ---- Sync commits will be reused if no new changes were added. @@ -155,13 +155,13 @@ This can be useful when iterating on a prompt, and discarding results from prior [source] ---- -o (main) -o draft! sync(prompt) -|\ -| \ -|\ o draft! prompt: (refs/drafts/123/1) -| o draft! prompt: (refs/drafts/123/2) o draft! prompt: (refs/drafts/123/3) +| o draft! prompt: (refs/drafts/123/2) +|/ o draft! prompt: (refs/drafts/123/1) +| / +|/ +o draft! sync(prompt) +o (main) ----