Improve documentation #768

docs/source/index.rst

@@ -42,7 +42,7 @@ What can you do PurlDB?
   :ref:`symbols_and_strings`.
 
 - Detect software supply chain issues by mapping package binaries to their corresponding source code
-  and determining if there are possible discrepancies between sources and sources (such as with the
+  and determining if there are possible discrepancies between sources and binaries (such as with the
   XZ utils attack, or sources and binaries, where package may not report the exact source code
   used to build binaries with the :ref:`deploy_to_devel` mapping analysis.
 

docs/source/purldb/purl_watch.rst

@@ -7,7 +7,7 @@ Maintaining an Up-to-Date PurlDB with PurlWatch
 PurlDB serves as a knowledge base for packages. It is essential to
 keep this knowledge base updated as new package versions are released daily.
 PurlWatch is responsible for keeping PurlDB up-to-date. Depending on the PurlDB
-size PurlWatch provides two different approach.
+size, PurlWatch provides two different approaches.
 
 Methods to Keep PurlDB Updated
 ------------------------------
@@ -48,7 +48,7 @@ watch. It creates watch task for the PURL and enqueues it in RQ for execution.
 Advantages
 ~~~~~~~~~~
     - Background tasks ensure that the PurlDB remains updated without manual intervention.
-    - The watch frequency can be customized to balance the resource uses.
+    - The watch frequency can be customized to balance the resource usage.
     - Users can define the depth of data collection based on their needs.
 
 .. tip::

docs/source/purldb/rest_api.rst

@@ -906,9 +906,9 @@ Also each package can have list of ``addon_pipelines`` to run on the package.
 Find all addon pipelines `here. <https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html>`_
 
 
-If ``reindex`` flag is True then existing package will be rescanned, if ``reindex_set``
-is True then all the package in the same set will be rescanned.
-If reindex flag is set to true then all the non existing package will be indexed.
+If the ``reindex`` flag is set to True, existing package will be rescanned and all the non existing package will be indexed.
+If the ``reindex_set`` flag is set to True, then all the package in the same set will be rescanned.
+
 
 .. Note::
 
@@ -970,7 +970,11 @@ Then return a mapping containing:
     - The number of package urls that are not processable by the index queue.
 - unsupported_packages
     - A list of package urls that are not processable by the index queue.
-        The package indexing queue can only handle npm and maven purls.
+        The package indexing queue can handle certain supported purl
+        types such as npm, pypi, maven, etc. See "supported_ecosystems"
+        list in
+        https://github.com/aboutcode-org/purldb/blob/main/packagedb/api.py
+        for details.
 - unsupported_vers_count
     - The number of vers range that are not supported by the univers or package_manager.
 - unsupported_vers
@@ -1072,8 +1076,9 @@ Package Update Set List
 Take a list of purls (where each item is a mapping containing PURL and
 content_type).
 
-If uuid is given then all purls will be added to package set if it exists else a
-new set would be created and all the purls will be added to that new set.
+If uuid is given, all purls will be added to the package set if it exists;
+otherwise, a new set will be created and all the purls will be added to
+that set.
 
 .. Note::
 
@@ -1115,7 +1120,7 @@ Package Set List
 
 Return a list of package sets and the package data of packages within
 
-``GET /api/projects/0bbdcf88-ad07-4970-9272-7d5f4c82cc7b/``
+``GET /api/package_sets/``
 
 .. code-block:: json