Editing this Wiki

Editing this Wiki

This wiki is a set of Markdown pages rendered by GitHub (GFM + the wiki-link extension). It lives in the wiki/ directory of the project for editing, but is its own git repo (the GitHub EveryConfig.wiki.git) and is gitignored by the main repo.

Workflow

1. Edit the .md files under wiki/.
2. Update _Sidebar.md if you add or rename a page.
3. Commit & push the wiki repo independently of the main repo.

cd wiki
# first time only:
git init && git remote add origin <EveryConfig.wiki.git>
git add . && git commit -m "docs: update wiki" && git push -u origin master

Link rules (the ones that bite)

• Never put a piped wiki-link [[Text|Page]] inside a Markdown table — the table splits the cell at the | and the link breaks. In tables use [Text](Page-Name) or a non-piped [[Page Name]].
• Outside tables, [[Text|Page-Name]] is fine.
• A page file Foo-Bar.md is linked as [[Foo Bar]] or [Foo Bar](Foo-Bar) (no .md).

Find broken piped-links-in-tables:

grep -rnE '^\|.*\[\[[^]]*\|[^]]*\]\]' *.md   # should be empty

Conventions

• One # H1 per page.
• Prefer runnable example code over prose; show the code directly (no "30-second version" callout).
• Use > callouts for the non-obvious — gotchas, comment fidelity, the in-memory-save principle.
• Keep version coordinates (EveryConfig:1.0.1) consistent; they are maintained by hand. The library's major tracks Jackson's major (1.x ⟷ Jackson 2.x).

Special pages

File	Role
Home.md	the landing page
_Sidebar.md	the left navigation
_Footer.md	the footer on every page
CLAUDE.md	these authoring conventions (local-only)

See Home for the page index.