Commit a1e7dc59382b1e6b1b054832b185ca2c77370569

Authored by reporkey
1 parent ac9e0da3

Drop CI configs; wiki is localhost-only

.github/workflows/publish.yml deleted
1   -name: Build and publish wiki
2   -
3   -on:
4   - push:
5   - branches: [main]
6   - workflow_dispatch:
7   -
8   -permissions:
9   - contents: write
10   - pages: write
11   - id-token: write
12   -
13   -jobs:
14   - build:
15   - runs-on: ubuntu-latest
16   - steps:
17   - - uses: actions/checkout@v4
18   -
19   - - name: Set up Python
20   - uses: actions/setup-python@v5
21   - with:
22   - python-version: "3.11"
23   - cache: pip
24   -
25   - - name: Install dependencies
26   - run: pip install -r requirements.txt
27   -
28   - - name: Build site
29   - run: mkdocs build --strict
30   -
31   - - name: Upload Pages artifact
32   - uses: actions/upload-pages-artifact@v3
33   - with:
34   - path: site
35   -
36   - deploy:
37   - needs: build
38   - runs-on: ubuntu-latest
39   - environment:
40   - name: github-pages
41   - url: ${{ steps.deployment.outputs.page_url }}
42   - steps:
43   - - name: Deploy to GitHub Pages
44   - id: deployment
45   - uses: actions/deploy-pages@v4
.gitlab-ci.yml deleted
1   -# GitLab Pages: build the MkDocs site and publish to GitLab Pages.
2   -# Triggered on every push to the default branch.
3   -#
4   -# Requirements on the GitLab project:
5   -# - GitLab Pages enabled (Settings → Pages).
6   -# - The default branch matches the `rules:` clause below (main).
7   -
8   -image: python:3.11-slim
9   -
10   -stages:
11   - - build
12   -
13   -pages:
14   - stage: build
15   - before_script:
16   - - pip install --quiet --upgrade pip
17   - - pip install --quiet -r requirements.txt
18   - script:
19   - # GitLab Pages requires the published directory to be named `public/`.
20   - - mkdocs build --strict --site-dir public
21   - artifacts:
22   - paths:
23   - - public
24   - rules:
25   - - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
README.md
... ... @@ -27,32 +27,24 @@ xly-wiki/
27 27 └── .venv/ ← gitignored Python venv
28 28 ```
29 29  
30   -## Quick start
  30 +## Reading the wiki — localhost
  31 +
  32 +Two ways, both equivalent:
31 33  
32 34 ```bash
  35 +# Live reload while editing (recommended)
33 36 source .venv/bin/activate # if .venv missing: python3 -m venv .venv && pip install -r requirements.txt
34   -mkdocs serve # http://127.0.0.1:8000 with live reload
  37 +mkdocs serve # http://127.0.0.1:8000
35 38 ```
36 39  
37   -## Publishing
38   -
39   -The repo is initialised but not yet pushed to a remote. To publish:
40   -
41 40 ```bash
42   -git remote add origin <your-remote-url>
43   -git push -u origin main
  41 +# One-off build, then open the static HTML directly
  42 +mkdocs build # writes site/
  43 +open site/index.html # macOS — or just double-click in Finder
44 44 ```
45 45  
46   -CI configs are included for both hosts — push to whichever you use:
47   -
48   -- **GitLab:** `.gitlab-ci.yml` builds and publishes to GitLab Pages
49   - on every push to the default branch. Enable Pages in
50   - *Project → Settings → Pages*.
51   -- **GitHub:** `.github/workflows/publish.yml` builds and publishes to
52   - GitHub Pages. Enable in *Settings → Pages → Source: GitHub Actions*.
53   -
54   -The unused config can stay — it's harmless and keeps the wiki portable
55   -between hosts.
  46 +That's the entire publish story. No CI, no remote hosting, no Pages.
  47 +The wiki lives on this machine.
56 48  
57 49 ## Out-of-scope
58 50  
... ...