Merge pull request #62 from pflooky/readme-files

Update markdown files in docs folder to use README file name, add in …
bitol-io · Jul 30, 2024 · f44bc45 · f44bc45
2 parents b96fcd3 + 5d97c0a
commit f44bc45
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -18,19 +18,19 @@ This standard describes a structure for a **data contract**. Its current version
 ## Discover the open standard
 A reader-friendly version of the standard can be found on its [dedicated site](https://bitol-io.github.io/open-data-contract-standard/).
 
-Discover the [Open Data Contract Standard](docs/standard.md). This file contains some explanations and several examples. More [examples](docs/examples/index.md) can be found here.
+Discover the [Open Data Contract Standard](docs/README.md). This file contains some explanations and several examples. More [examples](docs/examples/README.md) can be found here.
 
 ## What is a Data Contract?
 
 ### The basics of a data contract
 A data contract defines the agreement between a data producer and consumers. A data contract contains several sections:
 
-* [Fundamentals](docs/standard.md#demographics).
-* [Schema](docs/standard.md#dataset-and-schema).
-* [Data quality](docs/standard.md#data-quality).
-* [Service-level agreement (SLA)](docs/standard.md#service-level-agreement).
-* [Security & stakeholders](docs/standard.md#stakeholders).
-* [Custom properties](docs/standard.md#other-properties).
+* [Fundamentals](docs/README.md#demographics).
+* [Schema](docs/README.md#dataset-and-schema).
+* [Data quality](docs/README.md#data-quality-).
+* [Service-level agreement (SLA)](docs/README.md#service-level-agreement).
+* [Security & stakeholders](docs/README.md#stakeholders).
+* [Custom properties](docs/README.md#other-properties).
 
 ![Data contract schema](docs/img/data-contract-v2.2.1-schema.svg "Data contract schema")
 

diff --git a/docs/standard.md → docs/README.md b/docs/standard.md → docs/README.md
diff --git a/docs/examples/index.md → docs/examples/README.md b/docs/examples/index.md → docs/examples/README.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -33,8 +33,8 @@ theme:
 
 nav:
   - Home: 'index.md'
-  - Standard: 'standard.md'
-  - Examples: 'examples/index.md'
+  - Standard: 'README.md'
+  - Examples: 'examples/README.md'
   - Changelog: 'changelog.md'
   - Contributing: 'contributing.md'
   - Vendors: 'vendors.md'

diff --git a/script/README.md b/script/README.md
@@ -0,0 +1,9 @@
+# Script
+
+## Building docs
+
+The script [`build_docs.sh`](build_docs.sh) is used to help move some top level markdown files into the 
+[`docs`](../docs) directory to allow for mkdocs to create a website based on the markdown files.
+
+This script gets called via the [GitHub Action](../.github/workflows/docs-site-deploy.yaml) that will build and deploy 
+the documentation website.