From 610c4a0fe4c5d6fa0d87d310e4e6d87c1bfd5eb5 Mon Sep 17 00:00:00 2001 From: Aris <64918822+Arisamiga@users.noreply.github.com> Date: Wed, 29 Jul 2026 15:57:58 +0100 Subject: [PATCH 1/2] Initial Setup for Properdocs --- .github/workflows/web.yml | 41 +++++++++++++++++++++++++++++++++++++++ properdocs.yml | 9 +++++++++ requirements.txt | 3 +++ 3 files changed, 53 insertions(+) create mode 100644 .github/workflows/web.yml create mode 100644 properdocs.yml create mode 100644 requirements.txt diff --git a/.github/workflows/web.yml b/.github/workflows/web.yml new file mode 100644 index 0000000..f9b7608 --- /dev/null +++ b/.github/workflows/web.yml @@ -0,0 +1,41 @@ +name: ci + +on: + push: + branches: + - master + - main + +permissions: + contents: write + pages: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + + - uses: actions/setup-python@v5 + with: + python-version: 3.x + + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + + - name: Install dependencies + run: pip install -r requirements.txt properdocs + + - name: Deploy to GitHub Pages + run: properdocs gh-deploy --config-file properdocs.yml --force diff --git a/properdocs.yml b/properdocs.yml new file mode 100644 index 0000000..f3a7f69 --- /dev/null +++ b/properdocs.yml @@ -0,0 +1,9 @@ +site_name: Amiga OS 3.1/3.2 - Developer Source of Truth + +# CRITICAL: Tells ProperDocs that Markdown files live at root level +docs_dir: . + +theme: materialx + +plugins: + - same-dir \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d5876b0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +properdocs +mkdocs-materialx +mkdocs-same-dir \ No newline at end of file From 12eb29c2fdbcc203b7316e7c805f0cdc910bf8ce Mon Sep 17 00:00:00 2001 From: Aris <64918822+Arisamiga@users.noreply.github.com> Date: Wed, 29 Jul 2026 16:03:25 +0100 Subject: [PATCH 2/2] Add search bar --- properdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/properdocs.yml b/properdocs.yml index f3a7f69..d47bb19 100644 --- a/properdocs.yml +++ b/properdocs.yml @@ -6,4 +6,5 @@ docs_dir: . theme: materialx plugins: - - same-dir \ No newline at end of file + - same-dir + - search \ No newline at end of file