From 449656eb97a016fdf5fc115414fc58d3c4445012 Mon Sep 17 00:00:00 2001
From: Chewing_Bever <roosensjef@gmail.com>
Date: Fri, 17 Jun 2022 14:52:59 +0200
Subject: [PATCH] docs: updated to new 'kind' field

---
 CHANGELOG.md                         |  6 ++++++
 docs/api/source/includes/_targets.md |  4 ++++
 docs/content/usage/builds/_index.md  | 16 ++++++++--------
 3 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d01409a..eee1f9f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,12 +10,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * Server port can now be configured
+* Targets now have a 'kind' field describing whether it's a Git repository or a
+  URL to a PKGBUILD
+* Targets with kind 'url' can provide a direct URL to a PKGBUILD instead of
+  providing a Git repository
 
 ### Changed
 
 * Moved all API routes under `/v1` namespace
 * Renamed `vieter repos` to `vieter targets`
 * Renamed `/api/v1/repos` namespace to `/api/v1/targets`
+* Branch name for 'git' targets is now optional; if not provided, the
+  repository will be cloned with the default branch
 
 ### Removed
 
diff --git a/docs/api/source/includes/_targets.md b/docs/api/source/includes/_targets.md
index f7ea21e..c7061c8 100644
--- a/docs/api/source/includes/_targets.md
+++ b/docs/api/source/includes/_targets.md
@@ -24,6 +24,7 @@ curl \
   "data": [
     {
       "id": 1,
+      "kind": "git",
       "url": "https://aur.archlinux.org/discord-ptb.git",
       "branch": "master",
       "repo": "bur",
@@ -69,6 +70,7 @@ curl \
   "message": "",
   "data": {
     "id": 1,
+    "kind": "git",
     "url": "https://aur.archlinux.org/discord-ptb.git",
     "branch": "master",
     "repo": "bur",
@@ -108,6 +110,7 @@ Create a new target with the given data.
 
 Parameter | Description
 --------- | -----------
+kind | Kind of target to add; one of 'git', 'url'.
 url | URL of the Git repository.
 branch | Branch of the Git repository.
 repo | Vieter repository to publish built packages to.
@@ -132,6 +135,7 @@ id | id of target to modify
 
 Parameter | Description
 --------- | -----------
+kind | Kind of target; one of 'git', 'url'.
 url | URL of the Git repository.
 branch | Branch of the Git repository.
 repo | Vieter repository to publish built packages to.
diff --git a/docs/content/usage/builds/_index.md b/docs/content/usage/builds/_index.md
index 7babb06..e6c0b1c 100644
--- a/docs/content/usage/builds/_index.md
+++ b/docs/content/usage/builds/_index.md
@@ -20,24 +20,24 @@ pages](https://rustybever.be/man/vieter/vieter-targets.1.html) describe this in
 greater detail, but the basic usage is as follows:
 
 ```
-vieter targets add some-url some-branch some-repository
+vieter targets add some-url some-repository
 ```
 
 Here, `some-url` is the URL of the Git repository containing the PKGBUILD. This
 URL is passed to `git clone`, meaning the repository should be public. Vieter
 expects the same format as an AUR Git repository, so you can directly use AUR
-URLs here.
+URLs here. Alternatively, you can also provide the URL to a PKGBUILD file
+instead. See
+[vieter-targets-add(1)](https://rustybever.be/man/vieter/vieter-targets-add.1.html)
+for more information.
 
-`some-branch` is the branch of the Git repository the build should check out.
-If you're using an AUR package, this should be `master`.
-
-Finally, `some-repo` is the repository to which the built package archives
-should be published.
+`some-repo` is the repository to which the built package archives should be
+published.
 
 The above command intentionally leaves out a few parameters to make the CLI
 more useable. For information on how to modify all parameters using the CLI,
 see
-[vieter-targets-edit(1)](https://rustybever.be/man/vieter/vieter-targets-edit.1.html).
+[vieter-targets(1)](https://rustybever.be/man/vieter/vieter-targets.1.html).
 
 ## Reading logs