Skip to content

Commit ecb0994

Browse files
authored
docs: 💄 prettify the guide list in the landing page (#199)
# Description Makes it a list of items, rather than a row of them. Adds description to fill in the space a bit. Needs a quick review. ## Checklist - [x] Formatted Markdown - [x] Ran `just run-all`
1 parent 3e1db98 commit ecb0994

File tree

4 files changed

+5
-0
lines changed

4 files changed

+5
-0
lines changed

docs/guide/check.qmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Checking a Data Package's metadata"
3+
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."
34
jupyter: python3
45
order: 1
56
---

docs/guide/config.qmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Configuring the checks"
3+
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."
34
jupyter: python3
45
order: 3
56
---

docs/guide/index.qmd

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ description: "A guide on using `check-datapackage` to check the compliance of yo
44
listing:
55
contents: .
66
type: grid
7+
grid-columns: 1
78
sort: "order"
89
fields:
910
- title
11+
- description
1012
---

docs/guide/issues.qmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Understanding issues"
3+
description: "A short description about the `Issue` class that contains any problems found in your metadata when using `check()` on a `datapackage.json` file."
34
jupyter: python3
45
order: 2
56
---

0 commit comments

Comments
 (0)