Merge branch 'main' into docs/simplify-install-guide

Author: lwjohnst86

.pre-commit-config.yaml

@@ -25,6 +25,6 @@ repos:
   # sub-packages, which confuses pre-commit when it tries to find the latest
   # version
   - repo: https://github.com/adhtruong/mirrors-typos
-    rev: v1.39.0
+    rev: v1.39.2
     hooks:
       - id: typos

docs/guide/check.qmd

@@ -1,5 +1,6 @@
 ---
 title: "Checking a Data Package's metadata"
+description: "A brief walkthrough on how you can use the `check()` function to confirm that the metadata in your `datapackage.json` file complies with the Data Package standard."
 jupyter: python3
 order: 1
 ---

docs/guide/config.qmd

@@ -1,5 +1,6 @@
 ---
 title: "Configuring the checks"
+description: "A simple introduction to customising the types of checks that are done against your `datapackage.json` by using the `Config` class, such as excluding certain checks or adding your own."
 jupyter: python3
 order: 3
 ---

docs/guide/index.qmd

@@ -4,7 +4,9 @@ description: "A guide on using `check-datapackage` to check the compliance of yo
 listing:
     contents: .
     type: grid
+    grid-columns: 1
     sort: "order"
     fields:
         - title
+        - description
 ---

docs/guide/issues.qmd

@@ -1,5 +1,6 @@
 ---
 title: "Understanding issues"
+description: "A short description about the `Issue` class that contains any problems found in your metadata when using `check()` on a `datapackage.json` file."
 jupyter: python3
 order: 2
 ---

docs/index.qmd

@@ -11,24 +11,24 @@ specification](https://datapackage.org/standard/data-package/).
 
 ## Why use it?
 
-[Frictionless Data](https://frictionlessdata.io), who initially
-started and developed the Data Package specification, has several tools
-(listed on the [Frictionless](https://frictionlessdata.io/universe/) and
-[Data Package](https://datapackage.org/overview/software/) websites) for
+[Frictionless Data](https://frictionlessdata.io), who initially started
+and developed the Data Package specification, has several tools (listed
+on the [Frictionless](https://frictionlessdata.io/universe/) and [Data
+Package](https://datapackage.org/overview/software/) websites) for
 working with Data Packages, including a Python package called
 [`frictionless`](https://pypi.org/project/frictionless/). However, the
 `frictionless` package is a large package that does many things, and it
 can be difficult to navigate the documentation and interface to find and
 use the specific functionality you need. It also still implements Data
 Package version 1, while the latest is version 2.
 
-Since we found ourselves missing a tool we needed for our project, the
-[Seedcase Project](https://github.com/seedcase-project), we decided to
-build this package. We wanted a small, well-designed, and easy-to-use
-package that only checks the compliance of a Data Package against the
-current standard. We designed it for future CLI support, for instance
-using it in a [pre-commit](https://pre-commit.com/) hook or in CI
-pipelines like [GitHub Actions](https://docs.github.com/en/actions).
+Since we found ourselves missing a tool we needed for our [Seedcase
+Project](https://github.com/seedcase-project), we decided to build this
+package. We wanted a small, well-designed, and easy-to-use package that
+only checks the compliance of a Data Package against the current
+standard. We designed it for future CLI support, for instance using it
+in a [pre-commit](https://pre-commit.com/) hook or in CI pipelines like
+[GitHub Actions](https://docs.github.com/en/actions).
 
 ## Learning more