Skip to content

Contributing to This Wiki

Pages are Markdown files on disk. Adding one is: create a file, run the dev server, done.

Add a page

  1. Create a .md file in the section it belongs to — how-to/, troubleshooting/, reference/, or getting-started/.

  2. Give it frontmatter:

    markdown
    ---
    title: Reset a Forgotten Password
    order: 3
    tags: [accounts, passwords]
    ---
    
    # Reset a Forgotten Password
  3. Run npm run dev and check it at http://localhost:5173.

The sidebar picks up the new file automatically — there's no index to update. order: pins a page near the top of its section; pages without it sort alphabetically underneath.

Use double brackets. The target is matched by filename, case- and space-insensitive:

You writeYou get
[[connect-to-vpn]]link labelled "connect-to-vpn"
[[Connect to VPN]]same target, matched loosely
[[connect-to-vpn|the VPN guide]]link labelled "the VPN guide"
[[connect-to-vpn#split-tunneling]]link to a heading on that page
[[how-to/connect-to-vpn]]full path, needed when two files share a name

A link to a page that doesn't exist yet renders in orange with a ? — that's intentional. Link ahead to pages you plan to write; the marker tells you what's outstanding.

Style

  • One page per task or per symptom. If a page needs two <h1>-scale topics, split it.
  • Lead with the fix, not the background. People arrive mid-problem.
  • Use ::: warning / ::: danger for anything destructive or irreversible.
  • Tag pages so they show up on the Tags index.

Publish

powershell
npm run build

Output lands in .vitepress/dist, which is what IIS serves. See deploying.

Internal use only.