Skip to content
Gerrrt edited this page Jun 14, 2026 · 1 revision

wiki/ — staged source for the GitHub wiki

This folder is the versioned source for the project's GitHub wiki. A GitHub wiki is a separate git repo (dotfiles-core.wiki.git); keeping the pages here too means they're diffable, reviewable in PRs, and gated by the same audit as the rest of Core, then synced out to the wiki repo when ready.

How GitHub wikis work

  • Each *.md file is one page. The filename is the page title with hyphens becoming spaces: The-Zsh-Module-System.md → "The Zsh Module System".
  • Links between pages use the page name without .md: [Home](Home), [The Zsh Module System](The-Zsh-Module-System).
  • Three special filenames: Home.md (landing page), _Sidebar.md (nav shown on every page), _Footer.md (footer on every page).

Publishing these pages to the wiki

The wiki lives in its own repo. To publish, copy these files into a clone of it and push:

# one-time: clone the wiki repo somewhere outside this repo
git clone https://github.com/Gerrrt/dotfiles-core.wiki.git ../dotfiles-core.wiki

# each time you update the wiki:
cp wiki/*.md ../dotfiles-core.wiki/
cd ../dotfiles-core.wiki
git add -A && git commit -m "docs(wiki): sync from dotfiles-core/wiki" && git push

(The wiki repo's default branch is master.) You can also edit pages directly in the browser via the repo's Wiki tab — but for anything substantial, edit here and sync so the source stays versioned.

Current pages

  • Home.md — landing page + "start here" paths
  • _Sidebar.md — navigation (every page)
  • _Footer.md — footer (every page)
  • Architecture-and-the-Three-Layer-Model.md
  • The-Zsh-Module-System.md
  • Tools-Aliases-and-Functions.md
  • Neovim.md
  • tmux.md
  • Consuming-Core-in-an-OS-Repo.md
  • Porting-to-a-New-Distro.md
  • Maintenance-and-Updates.md
  • The-Audit-Quality-Gate.md
  • Contributing.md
  • FAQ-and-Troubleshooting.md

Clone this wiki locally