Skip to content

Commit 84e85fe

Browse files
Refactor Astro config and update contribution guidelines and webface guide
1 parent 4251fc0 commit 84e85fe

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

src/content/docs/development/contribution-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ description: A guide to help anyone contribute to OpenIPC's docs.
88
Thank you for contributing to the OpenIPC documentation! This guide will walk you through two main ways to contribute: **adding a new page** and **editing an existing page**. There’s also a section for setting up a local development environment if you want to test the site locally.
99

1010

11-
---
12-
1311
## Adding a New Page
1412

1513
### 1. Clone the Repository
@@ -52,6 +50,7 @@ Use the following table to determine where to add your new page based on its con
5250
:::danger
5351
Please make sure the name of the file is in snake-case (no uppercase letters and uses '-'). This will become later the url of the page.
5452
Do not forget to add the '.md' extension, so the site knows how to handle the file.
53+
:::
5554

5655
### 5. Add Frontmatter to Your Page
5756
At the top of the new markdown file, include the required frontmatter. This helps Starlight process the page correctly.
@@ -92,6 +91,7 @@ This is an image [Example Image](/src/assets/images/example-image.png)
9291
```
9392
:::caution
9493
Please place your image in `/src/assets/images`so that you can use it like this `[Example Image](/src/assets/images/example-image.png)`
94+
:::
9595

9696
### 7. Add Your Page to the Sidebar Navigation (If Required)
9797

src/content/docs/development/webface-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Web Interface Developer's Guide
3-
description: ???
3+
description: A guide to developing the OpenIPC web interface.
44
---
55

66
**slogan:** _document it, baby. ur mom._

0 commit comments

Comments
 (0)