diff --git a/index.qmd b/index.qmd index 2769a9f..f4e2aad 100644 --- a/index.qmd +++ b/index.qmd @@ -1,3 +1,88 @@ --- -title: "Welcome!" +toc: false +page-layout: custom --- + +::::: landing-page-block +:::: hero-text +::: text-center +![](_extensions/seedcase-project/seedcase-theme/logos/check-datapackage-logo.svg){fig-alt="Check datapackage logo." +width="150px"} + +![](_extensions/seedcase-project/seedcase-theme/logos/check-datapackage-font.svg){fig-alt="Check datapackage font." +height="50px"} + +## Ensure the correctness and compliance of your Data Package + +[Overview](/docs/index.qmd){.btn .about-link} [Explore +guide](/docs/guide/index.qmd){.btn .about-link} +::: +:::: +::::: + +:::: landing-page-block +::: {#hero-heading} +{{< include /docs/includes/_badges.qmd >}} +::: +:::: + +::::: hero-banner +:::: landing-page-block +::: hero-text +`check-datapackage` is a Python package that checks your Data Package's +metadata against the [Data Package standard](https://datapackage.org/), +helping you ensure that your metadata is compliant. + +## Key features :sparkles: + +- Checks the + [descriptor](https://datapackage.org/standard/glossary/#descriptor) + in your `datapackage.json` against the Data Package standard. +- Enables you to configure which components of the descriptor + should or should not be checked. +- Enables you to turn off specific checks defined in the standard. +- Supports user-defined, custom checks. +- Provides clear and user-friendly messages that point directly to + where issues occur in the descriptor. +- Supports a strict mode that enforces full compliance with the + standard, including all recommendations. + +:warning: Note that `check-datapackage` only checks the descriptor +against the Data Package standard---it does not check the data itself +against its descriptor. +::: +:::: +::::: + +::::: landing-page-block +:::: hero-text +## About the Seedcase Project + +`check-datapackage` is part of the [**Seedcase +Project**](https://seedcase-project.org), which helps research projects +manage and process data in line with the +[FAIR](https://www.go-fair.org/fair-principles/) principles. + +This package works as a standalone tool but is also integrated in +[Seedcase Sprout](https://sprout.seedcase-project.org), a Python package +that provides a framework for growing structured, organised, and FAIR +data. + +::: text-center +[Check out Sprout](https://sprout.seedcase-project.org/){.btn +.about-link} +::: +:::: +::::: + +::::: hero-banner +:::: landing-page-block +::: hero-text +## Want to contribute? + +We would love your feedback or contributions! Head over to the [GitHub +repository](https://github.com/seedcase-project/check-datapackage) to +share your ideas or contribute code. Your input makes us better! +::: +:::: +:::::