Skip to content

Commit 3301ccf

Browse files
committed
Update markdown files in docs folder to use README file name, add in README for script folder
1 parent b96fcd3 commit 3301ccf

File tree

4 files changed

+11
-2
lines changed

4 files changed

+11
-2
lines changed
File renamed without changes.
File renamed without changes.

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ theme:
3333

3434
nav:
3535
- Home: 'index.md'
36-
- Standard: 'standard.md'
37-
- Examples: 'examples/index.md'
36+
- Standard: 'README.md'
37+
- Examples: 'examples/README.md'
3838
- Changelog: 'changelog.md'
3939
- Contributing: 'contributing.md'
4040
- Vendors: 'vendors.md'

script/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Script
2+
3+
## Building docs
4+
5+
The script [`build_docs.sh`](build_docs.sh) is used to help move some top level markdown files into the
6+
[`docs`](../docs) directory to allow for mkdocs to create a website based on the markdown files.
7+
8+
This script gets called via the [GitHub Action](../.github/workflows/docs-site-deploy.yaml) that will build and deploy
9+
the documentation website.

0 commit comments

Comments
 (0)