diff --git a/docs/guide/check.qmd b/docs/guide/check.qmd index c01388e8..92ba4af8 100644 --- a/docs/guide/check.qmd +++ b/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 --- diff --git a/docs/guide/config.qmd b/docs/guide/config.qmd index 490700b1..58798654 100644 --- a/docs/guide/config.qmd +++ b/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 --- diff --git a/docs/guide/index.qmd b/docs/guide/index.qmd index a849e7ac..d95883f5 100644 --- a/docs/guide/index.qmd +++ b/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 --- diff --git a/docs/guide/issues.qmd b/docs/guide/issues.qmd index 53428e9b..2362e744 100644 --- a/docs/guide/issues.qmd +++ b/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 ---