Skip to content

Commit 210fda4

Browse files
Fix MkDocs configuration
1 parent 694f442 commit 210fda4

4 files changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This repository contains configuration files and documentation used by OpenBrand
88
## Documentation
99

1010
For an overview of the organization, visit the [profile README](profile/README.md).
11+
The MkDocs site is built from the files in the [`docs/`](docs/) directory.
1112

1213
## Development
1314

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# OpenBrand Documentation
2+
3+
This site contains documentation about the OpenBrand organization.
4+
5+
For repository details, see the [main README](../README.md).
6+
7+
Learn more about our organization on the [profile page](profile.md).

docs/profile.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# OpenBrand Profile
2+
3+
This page mirrors the information in [profile/README.md](../profile/README.md).

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: OpenBrand Docs
22
nav:
3-
- Home: README.md
4-
- Profile: profile/README.md
5-
docs_dir: .
3+
- Home: index.md
4+
- Profile: profile.md
5+
docs_dir: docs

0 commit comments

Comments
 (0)