Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Docs — Local build & dev

Prerequisites
- Python 3.8+ and pip

Install
1. python -m pip install --upgrade pip
2. pip install mkdocs mkdocs-material

Run locally
- mkdocs serve
Open http://127.0.0.1:8000 in your browser.

Build for preview
- mkdocs build --site-dir site

Notes
- The CI builds the site and runs a link checker. If you add external links, double-check them here before opening PRs.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Docs — build & link-check

on:
push:
paths:
- 'docs/**'
- '.github/workflows/**'
pull_request:
paths:
- 'docs/**'
- '.github/workflows/**'

jobs:
build-and-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: Install mkdocs + theme
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material

- name: Build docs
run: |
mkdocs build --clean --site-dir site

- name: Run link checker (lychee)
uses: lycheeverse/lychee-action@v1
with:
args: --recursive site
16 changes: 16 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
site_name: Veiled Dominion — Docs
docs_dir: docs
site_dir: site
theme:
name: material

nav:
- Home: Home.md
- Quickstart: Quickstart.md
- Rules: Rules.md
- Design Goals: Design_Goals.md
- Architecture: ARCHITECTURE_OVERVIEW.md
- Public Domain Design: PUBLIC_DOMAIN_DESIGN.md
- Contributing: Contributing.md
- Roadmap: Roadmap.md
- Current Status: Current_Status.md
Loading