Minor improvements (#955)

* Added seo descriptions * Added back-to-top * Removed react * Removed unused comments
frictionlessdata · Jun 27, 2024 · a0c241f · a0c241f
1 parent 1f48855
commit a0c241f
Show file tree

Hide file tree

Showing 13 changed files with 166 additions and 1,040 deletions.
diff --git a/astro.config.js b/astro.config.js
@@ -15,6 +15,8 @@ export default defineConfig({
   integrations: [
     starlight({
       title: "Data Package Standard",
+      description:
+        "Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data.",
       logo: {
         light: "/assets/logo-light.svg",
         dark: "/assets/logo-dark.svg",
@@ -32,6 +34,7 @@ export default defineConfig({
       customCss: ["/assets/styles.css"],
       tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 5 },
       components: {
+        MarkdownContent: "./components/MarkdownContent.astro",
         SocialIcons: "./components/SocialIcons.astro",
       },
       plugins: [

diff --git a/components/MarkdownContent.astro b/components/MarkdownContent.astro
@@ -0,0 +1,12 @@
+---
+import type { Props } from "@astrojs/starlight/props"
+import Default from "@astrojs/starlight/components/MarkdownContent.astro"
+---
+
+<Default {...Astro.props}><slot /></Default>
+
+<script>
+  import { addBackToTop } from "vanilla-back-to-top"
+
+  addBackToTop({ backgroundColor: "#3272C2", scrollDuration: 200 })
+</script>
diff --git a/components/SocialIcons.astro b/components/SocialIcons.astro
@@ -8,7 +8,6 @@ import Default from "@astrojs/starlight/components/SocialIcons.astro"
 >
 <a href="https://specs.frictionlessdata.io/"><strong>v1</strong></a>
 
-<!-- Render the default social links. -->
 <Default {...Astro.props}><slot /></Default>
 
 <!-- Add styles to mimic the default links appearance. -->

diff --git a/content/docs/index.mdx b/content/docs/index.mdx
@@ -1,7 +1,5 @@
 ---
 title: Data Package
-description: |
-  Data Package standard.
 template: splash
 editUrl: false
 hero:

diff --git a/content/docs/standard/data-package.md b/content/docs/standard/data-package.md
@@ -1,5 +1,6 @@
 ---
 title: Data Package
+description: A simple container format for describing a coherent collection of data in a single 'package'. It provides the basis for convenient delivery, installation and management of datasets.
 sidebar:
   order: 1
 ---

diff --git a/content/docs/standard/data-resource.md b/content/docs/standard/data-resource.md
@@ -1,5 +1,6 @@
 ---
 title: Data Resource
+description: A simple format to describe and package a single data resource such as a individual table or file. The essence of a Data Resource is a locator for the data it describes. A range of other properties can be declared to provide a richer set of metadata.
 sidebar:
   order: 2
 ---

diff --git a/content/docs/standard/extensions.md b/content/docs/standard/extensions.md
@@ -1,5 +1,6 @@
 ---
 title: Extensions
+description: The Data Package Standard extensibility features for domain-specific needs.
 sidebar:
   order: 5
 ---

diff --git a/content/docs/standard/glossary.md b/content/docs/standard/glossary.md
@@ -1,5 +1,6 @@
 ---
 title: Glossary
+description: A glossary of terms used in the Data Package standard.
 sidebar:
   order: 6
 ---

diff --git a/content/docs/standard/security.md b/content/docs/standard/security.md
@@ -1,5 +1,6 @@
 ---
 title: Security
+description: Security considerations around Data Packages and Data Resources.
 sidebar:
   order: 7
 ---

diff --git a/content/docs/standard/table-dialect.md b/content/docs/standard/table-dialect.md
@@ -1,5 +1,6 @@
 ---
 title: Table Dialect
+description: Table Dialect describes how tabular data is stored in a file. It supports delimited text files like CSV, semi-structured formats like JSON and YAML, and spreadsheets like Microsoft Excel.
 sidebar:
   order: 3
 ---

diff --git a/content/docs/standard/table-schema.md b/content/docs/standard/table-schema.md
@@ -1,5 +1,6 @@
 ---
 title: Table Schema
+description: Table Schema is a simple language- and implementation-agnostic way to declare a schema for tabular data.
 sidebar:
   order: 4
 ---