diff --git a/README.md b/README.md index effb8bc..c8bbf85 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ xly-wiki/ │ └── precommit.sh ← optional git hook ├── mkdocs.yml ├── requirements.txt -├── .github/workflows/publish.yml (GitHub Actions: builds + publishes site/) └── .venv/ ← gitignored Python venv ``` diff --git a/docs/contributing.md b/docs/contributing.md index 0b50c6e..32e3fe5 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -5,13 +5,15 @@ How to fix or extend this wiki. ## Quick fix (a typo, a sentence) 1. Edit the relevant `.md` file under `docs/`. -2. The pre-commit hook regenerates the static site under `site/`. -3. Commit. Push. CI publishes. +2. Run `mkdocs build` to regenerate the static site under `site/`, or + `mkdocs serve` to preview live. +3. Commit when satisfied. -You do not need to install anything for typo-level fixes if you use the GitHub web -editor — CI alone will rebuild and publish. +The wiki lives on this machine — there is no remote, no CI, no Pages. +Anyone reading the wiki opens `site/index.html` locally or runs +`mkdocs serve` themselves. -## Local dev (preview before commit) +## Local dev (preview while editing) ```bash cd xly-wiki @@ -41,7 +43,7 @@ chmod +x scripts/precommit.sh ``` The hook runs `mkdocs build --strict` on every commit so broken cross-refs are -caught before they get pushed. +caught before they land in a commit. ## Style