Commit 2d66a3178dee06c6c5d0241172ff6d52d0da829f
1 parent
a1e7dc59
Drop GitHub/CI/Pages references — wiki is local-only
Showing
2 changed files
with
8 additions
and
7 deletions
README.md
| @@ -23,7 +23,6 @@ xly-wiki/ | @@ -23,7 +23,6 @@ xly-wiki/ | ||
| 23 | │ └── precommit.sh ← optional git hook | 23 | │ └── precommit.sh ← optional git hook |
| 24 | ├── mkdocs.yml | 24 | ├── mkdocs.yml |
| 25 | ├── requirements.txt | 25 | ├── requirements.txt |
| 26 | -├── .github/workflows/publish.yml (GitHub Actions: builds + publishes site/) | ||
| 27 | └── .venv/ ← gitignored Python venv | 26 | └── .venv/ ← gitignored Python venv |
| 28 | ``` | 27 | ``` |
| 29 | 28 |
docs/contributing.md
| @@ -5,13 +5,15 @@ How to fix or extend this wiki. | @@ -5,13 +5,15 @@ How to fix or extend this wiki. | ||
| 5 | ## Quick fix (a typo, a sentence) | 5 | ## Quick fix (a typo, a sentence) |
| 6 | 6 | ||
| 7 | 1. Edit the relevant `.md` file under `docs/`. | 7 | 1. Edit the relevant `.md` file under `docs/`. |
| 8 | -2. The pre-commit hook regenerates the static site under `site/`. | ||
| 9 | -3. Commit. Push. CI publishes. | 8 | +2. Run `mkdocs build` to regenerate the static site under `site/`, or |
| 9 | + `mkdocs serve` to preview live. | ||
| 10 | +3. Commit when satisfied. | ||
| 10 | 11 | ||
| 11 | -You do not need to install anything for typo-level fixes if you use the GitHub web | ||
| 12 | -editor — CI alone will rebuild and publish. | 12 | +The wiki lives on this machine — there is no remote, no CI, no Pages. |
| 13 | +Anyone reading the wiki opens `site/index.html` locally or runs | ||
| 14 | +`mkdocs serve` themselves. | ||
| 13 | 15 | ||
| 14 | -## Local dev (preview before commit) | 16 | +## Local dev (preview while editing) |
| 15 | 17 | ||
| 16 | ```bash | 18 | ```bash |
| 17 | cd xly-wiki | 19 | cd xly-wiki |
| @@ -41,7 +43,7 @@ chmod +x scripts/precommit.sh | @@ -41,7 +43,7 @@ chmod +x scripts/precommit.sh | ||
| 41 | ``` | 43 | ``` |
| 42 | 44 | ||
| 43 | The hook runs `mkdocs build --strict` on every commit so broken cross-refs are | 45 | The hook runs `mkdocs build --strict` on every commit so broken cross-refs are |
| 44 | -caught before they get pushed. | 46 | +caught before they land in a commit. |
| 45 | 47 | ||
| 46 | ## Style | 48 | ## Style |
| 47 | 49 |