From 7971ecb6fb022eab4b2b58a920460dc42fc60741 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Mon, 17 Nov 2025 12:21:20 +0100 Subject: [PATCH 1/3] docs: :lipstick: improves the look of the Guide landing page --- docs/guide/check.qmd | 1 + docs/guide/config.qmd | 1 + docs/guide/index.qmd | 3 +++ docs/guide/issues.qmd | 1 + 4 files changed, 6 insertions(+) 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..384c2e1e 100644 --- a/docs/guide/config.qmd +++ b/docs/guide/config.qmd @@ -1,5 +1,6 @@ --- title: "Configuring the checks" +description: "Customise 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..278e8ecf 100644 --- a/docs/guide/index.qmd +++ b/docs/guide/index.qmd @@ -4,7 +4,10 @@ description: "A guide on using `check-datapackage` to check the compliance of yo listing: contents: . type: grid + grid-columns: 1 + grid-item-border: false 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 --- From 102f30c7d120fbe325922fb2f458a9d823a6e54d Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Tue, 18 Nov 2025 09:13:50 +0100 Subject: [PATCH 2/3] docs: :memo: align description with others --- docs/guide/config.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/config.qmd b/docs/guide/config.qmd index 384c2e1e..58798654 100644 --- a/docs/guide/config.qmd +++ b/docs/guide/config.qmd @@ -1,6 +1,6 @@ --- title: "Configuring the checks" -description: "Customise 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." +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 --- From 0677fc64b7712089e6def9b753330729a367bfb2 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Tue, 18 Nov 2025 09:14:02 +0100 Subject: [PATCH 3/3] style: :lipstick: keep grid lines --- docs/guide/index.qmd | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/guide/index.qmd b/docs/guide/index.qmd index 278e8ecf..d95883f5 100644 --- a/docs/guide/index.qmd +++ b/docs/guide/index.qmd @@ -5,7 +5,6 @@ listing: contents: . type: grid grid-columns: 1 - grid-item-border: false sort: "order" fields: - title