From f7b2ba52dc60699f37b77c7baa9afadc4e67a3dc Mon Sep 17 00:00:00 2001
From: Jacques Raphanel <147158906+TheCrab13@users.noreply.github.com>
Date: Sun, 24 Mar 2024 14:24:32 +0100
Subject: [PATCH] docs: improve documentation (#23)

---
 CHANGELOG.md                 |  6 +++---
 docs/source/cli-commands.rst |  2 +-
 docs/source/commands/add.rst | 13 +++++++------
 docs/source/commands/del.rst | 12 +++++-------
 4 files changed, 16 insertions(+), 17 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d6a1980..9a32cab 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,9 +10,9 @@
 
 ### Fix
 
-* fix(transaction): no transaction created if file already exists from … (#19) ([`1754d19`](https://github.com/crabisoft/pdbstore/commit/1754d19153c99006d5d1b61cf55679f319c0934d))
+* fix(transaction): no transaction created if file already exists from store (#19) ([`1754d19`](https://github.com/crabisoft/pdbstore/commit/1754d19153c99006d5d1b61cf55679f319c0934d))
 
-### Unknown
+### Documentation
 
 * doc: refactor documentation (#20) ([`c600537`](https://github.com/crabisoft/pdbstore/commit/c600537d6c9b348ecf0004d11a0920cb94979d7d))
 
@@ -34,7 +34,7 @@
 
 * test: add dedicated compression test when supported (#14) ([`3b6dfda`](https://github.com/crabisoft/pdbstore/commit/3b6dfdab3eb58d35735d0149d480cc9488548ff6))
 
-### Unknown
+### Documentation
 
 * doc: add promote command (#16) ([`c0e5328`](https://github.com/crabisoft/pdbstore/commit/c0e5328e1f725bc7eeac4fc98f802effd51f7bc0))
 
diff --git a/docs/source/cli-commands.rst b/docs/source/cli-commands.rst
index c6c2cc7..5021a19 100644
--- a/docs/source/cli-commands.rst
+++ b/docs/source/cli-commands.rst
@@ -1,7 +1,7 @@
 CLI reference
 =============
 
-This section describe the Conan built-in commands, like ``pdbstore add`` or ``pdbstore del``.
+This section describe the **pdbstore** built-in commands, like ``pdbstore add`` or ``pdbstore del``.
 
 **Storage commands:**
 
diff --git a/docs/source/commands/add.rst b/docs/source/commands/add.rst
index 694cfc8..2d1eddb 100644
--- a/docs/source/commands/add.rst
+++ b/docs/source/commands/add.rst
@@ -60,9 +60,10 @@ The ``pdbstore add`` command stores all supported binary files, based on command
 into the specified store.
 
 The ``pdbstore add`` command will:
-- search for Portable Executable (**PE**) and **PDB** files if input directory is given
-- check all input files to detect **PE** and **PDB** files
-- extract **GUID** and **age** from required files
-- add files that are not referenced yet based on their **GUID** and **age**
-- delete oldest transactions if required
-- print a summary to **stdout** stream
\ No newline at end of file
+
+* Search for Portable Executable (**PE**) and **PDB** files if input directory is given.
+* Check all input files to detect **PE** and **PDB** files.
+* Extract **GUID** and **age** from required files.
+* Add files that are not referenced yet based on their **GUID** and **age**.
+* Delete oldest transactions if required.
+* Print a summary to **stdout** stream.
\ No newline at end of file
diff --git a/docs/source/commands/del.rst b/docs/source/commands/del.rst
index 5743bb5..5e40f36 100644
--- a/docs/source/commands/del.rst
+++ b/docs/source/commands/del.rst
@@ -44,14 +44,12 @@ anymore by the store.
 The ``--dry-run`` option can be used to obtain a summary of files to be deleted along
 the specified transaction.
 
-The ``pdbstore del`` will perform the requested delete operation with using transaction
+The ``pdbstore del`` will perform the requested delete operation using transaction
 identifier as unique criteria. If you want to delete transactions given more criteria,
 please refer to :ref:`commands_clean` command
 
 The ``pdbstore del`` command will:
-- search for Portable Executable (**PE**) and **PDB** files if input directory is given
-- check all input files to detect **PE** and **PDB** files
-- extract **GUID** and **age** from required files
-- add files that are not referenced yet based on their **GUID** and **age**
-- delete oldest transactions if required
-- print a summary to **stdout** stream
+
+* Search the requested transaction given by its identifier
+* Collect all files that are referenced only by the transaction
+* Remove all required files and empty directories