docs: n34 book

Signed-off-by: Awiteb <a@4rs.nl>

docs/issue/README.md

@@ -0,0 +1,15 @@
+# Issue Management
+
+Using `n34`, you can manage Git issues stored in Nostr relays, adhering to
+the [NIP-34] standard. In Nostr, events are immutable, meaning their IDs are
+derived from the SHA-256 hash of their timestamp, content, author, and tags.
+As a result, issues cannot be edited directly. However, with `n34`, you can
+create new issues, view existing ones, or update their status—such as closing,
+resolving, or reopening them.
+
+[NIP-34] introduces support for drafting issues, though this feature is not
+currently implemented in `n34` due to the lack of a clear use case for drafting
+issues. The inclusion of this functionality may stem from its shared use in both
+issues and patches, suggesting it was primarily designed for patch management.
+
+[NIP-34]: https://github.com/nostr-protocol/nips/blob/master/34.md

docs/issue/close.md

@@ -0,0 +1,19 @@
+# Closes an Open Issue
+
+> `n34 issue close` command
+
+**Usage:**
+```
+Closes an open issue
+
+Usage: n34 issue close [OPTIONS] <ISSUE_ID>
+
+Arguments:
+  <ISSUE_ID>  The open issue id to close it
+
+Options:
+      --repo <NADDR-NIP05-OR-SET>  Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
+```
+
+Issue a kind `1632` (Close status) for the specified issue. The issue have to
+be open.

docs/issue/list.md

@@ -0,0 +1,19 @@
+# List Repositories Issues
+
+> `n34 issue list` command
+
+**Usage:**
+```
+List the repositories issues
+
+Usage: n34 issue list [OPTIONS] [NADDR-NIP05-OR-SET]...
+
+Arguments:
+  [NADDR-NIP05-OR-SET]...  Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
+
+Options:
+      --limit <LIMIT>  Maximum number of issues to list [default: 15]
+```
+
+List the repositories issues. By default `n34` will look for `nostr-address`
+file and extract the repositories from it.

docs/issue/new.md

@@ -0,0 +1,29 @@
+# Create an Issue
+
+> `n34 issue new` Command
+
+**Usage:**
+```
+Create a new repository issue
+
+Usage: n34 issue new [OPTIONS] <--content <CONTENT>|--editor>
+
+Options:
+      --repo <NADDR-NIP05-OR-SET>  Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
+  -c, --content <CONTENT>          Markdown content for the issue. Cannot be used together with the `--editor` flag
+  -e, --editor                     Opens the user's default editor to write issue content. The first line will be used as the issue subject
+      --subject <SUBJECT>          The issue subject. Cannot be used together with the `--editor` flag
+  -l, --label <LABEL>              Labels for the issue. Can be specified as arguments (-l bug) or hashtags in content (#bug)
+```
+
+Use the `n34 issue new` command to create a new issue in a repository. This
+command supports the [NIP-21] (`nostr:` URI scheme) and hashtags within the
+issue content. When you mention public keys in the content, they will be
+included in the event tags. Additionally, using hashtags like `#bug` in the
+issue body will automatically apply them as labels.
+
+You must choose between the `--content` and `--editor` options. With
+`--content`, you provide the issue content directly in the command. With
+`--editor`, your default `$EDITOR` will open, allowing you to write the issue
+content. The first line of the editor's output will be used as the issue
+subject.

docs/issue/reopen.md

@@ -0,0 +1,19 @@
+# Reopen a Closed Issue
+
+> `n34 issue reopen` command
+
+**Usage:**
+```
+Reopens a closed issue
+
+Usage: n34 issue reopen [OPTIONS] <ISSUE_ID>
+
+Arguments:
+  <ISSUE_ID>  The ID of the closed issue to reopen
+
+Options:
+      --repo <NADDR-NIP05-OR-SET>  Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
+```
+
+Issue a kind `1630` (Open status) for the specified issue. The issue have to
+be closed.

docs/issue/resolve.md

@@ -0,0 +1,18 @@
+# Resolves an Issue
+
+> `n34 issue resolve` command
+
+**Usage:**
+```
+Resolves an issue
+
+Usage: n34 issue resolve [OPTIONS] <ISSUE_ID>
+
+Arguments:
+  <ISSUE_ID>  The issue id to resolve it
+
+Options:
+      --repo <NADDR-NIP05-OR-SET>  Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
+```
+
+Issue a kind `1631` (Resolved status) event for the specified issue.

docs/issue/view.md

@@ -0,0 +1,19 @@
+# View an Issue By ID
+
+> `n34 issue view` command
+
+**Usage:**
+```
+View an issue by its ID
+
+Usage: n34 issue view [OPTIONS] <ISSUE_ID>
+
+Arguments:
+  <ISSUE_ID>  The issue id to view it
+
+Options:
+      --repo <NADDR-NIP05-OR-SET>  Repository address in `naddr` format (`naddr1...`), NIP-05 format (`4rs.nl/n34` or `_@4rs.nl/n34`), or a set name like `kernel`
+```
+
+Simply provide the issue ID in `note` or `nevent` format to retrieve and display
+the issue details.