Skip to content

Commit 86a5d6c

Browse files
authored
refactor: reorganize user guide docs sources (#226)
1 parent bd60101 commit 86a5d6c

13 files changed

Lines changed: 6 additions & 4 deletions

.github/workflows/docs-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
run: pip install mkdocs-material
4949

5050
- name: Copy License
51-
run: cp LICENSE.md docs/user-guide/docs/license.md
51+
run: cp LICENSE.md docs/user-guide/src/license.md
5252

5353
- name: Build Site
5454
working-directory: docs/user-guide/

.github/workflows/docs-validate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
run: pip install mkdocs-material
4949

5050
- name: Copy License
51-
run: cp LICENSE.md docs/user-guide/docs/license.md
51+
run: cp LICENSE.md docs/user-guide/src/license.md
5252

5353
- name: Build Site
5454
working-directory: docs/user-guide/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ $ docker run -d -it \
3838
3939
> [!TIP]
4040
> You can customize the server using **environment variables** or **configuration files**.
41-
> Learn more in the [configuration guide](docs/user-guide/docs/configuration.md).
41+
> Learn more in the [configuration guide](docs/user-guide/src/configuration.md).
4242
>
4343
> For production-grade deployments, we recommend following
44-
> [our dedicated setup guide](docs/user-guide/docs/production-grade-deployment.md).
44+
> [our dedicated setup guide](docs/user-guide/src/production-grade-deployment.md).
4545
4646
## ✨ Highlights
4747

docs/user-guide/mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ site_author: Djaytan
55
site_url: https://djaytan.github.io/docker-papermc-server/
66
copyright: Copyright © 2025 Djaytan
77

8+
docs_dir: src/
9+
810
theme:
911
name: material
1012
locale: en
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)