Skip to content
rayswaynl edited this page Jul 3, 2026 · 1 revision

Agent Guidance — a2waspwarfare Wiki

This file governs agents editing the GitHub wiki (rayswaynl/a2waspwarfare.wiki). For mission source, SQF, and PR rules see the mission-repo AGENTS.md / CLAUDE.md at the root of rayswaynl/a2waspwarfare.

What This Repo Is

The wiki is a companion knowledge base for the rayswaynl/a2waspwarfare Arma 2 OA 1.64 Warfare mission. It has no CI. Every merge goes directly to the GitHub wiki. Codex agents commit here frequently; the remote moves fast.

Before You Edit

  1. git pull --rebase before every edit session. Remote moves fast; Codex lanes commit directly.
  2. Read Agent-Worklog.md and agent-status.json to check claimed pages and in-flight edits.
  3. Claim your scope in Agent-Worklog.md (append an entry) before editing any page. Format: ## <ISO timestamp> - <Agent-ID> - <claim or release>. Do not reorder existing entries.
  4. If a push races (non-fast-forward), fetch, rebase your commit on top of origin/master, union-merge any conflicting sections (keep both agents' content), and push. Do not force-push.

Editing Rules

Line endings: all .md files in this wiki use CRLF. Write new files with CRLF. Do not convert existing files to LF — that produces diff churn across every line.

No reflowing: edit only the lines you intend to change. Do not reformat, re-wrap, or re-indent paragraphs you did not author. Formatter churn makes PR review impossible.

Page naming: Title-Cased-Kebab.md. GitHub wiki maps page title to filename; spaces become hyphens. Use the same casing convention as existing pages.

Cross-links: use wiki-relative links without .md extension, e.g. [LLM Agent Entry Pack](LLM-Agent-Entry-Pack). Do not use bare URLs for internal pages. Anchor links use #heading-slug (GitHub lowercases and hyphens heading text).

ValidateWiki must pass: run powershell -ExecutionPolicy Bypass -File validate-wiki.ps1 from the wiki root before every push. It checks: JSON/JSONL parse, broken local links, stale optimistic-status phrases, control characters, and (when in a git checkout) git diff --check.

Stale-phrase ban: do not write optimistic-status phrases. Read $stalePatterns in validate-wiki.ps1 lines 144-153 for the exact match list. Any such phrase triggers a validator error.

GUIDE-REV stamp: every new page must include <!-- GUIDE-REV: GR-2026-07-03a --> in a comment near the top. Updated pages must add or update this stamp.

4-Surface Navigation Rule

When you add a new page that is primary content (not archive or machine-file), you must register it on ALL FOUR surfaces:

  1. _Sidebar.md — add to the appropriate section
  2. _Footer.md — add to the shared footer link bar
  3. Home.md — add to the relevant route table
  4. Page-Index.md — add a one-line entry in the correct section

Check Navigation-Inventory-And-Page-Status.md for section guidance before adding.

After You Edit

  • Run validate-wiki.ps1 and fix all errors before committing.
  • Commit message format: docs: <summary> — no Co-Authored-By trailers.
  • Append a release entry to Agent-Worklog.md when done: state pages changed and validation result.
  • If push fails (non-fast-forward): git fetch && git rebase origin/master, union-merge conflicts preserving both agents' content, then push.

Key Files

File Purpose
agent-status.json Active/watchlist lanes — check before claiming
agent-collaboration.json Current claim/ownership surface
Agent-Worklog.md Append-only human+agent worklog
validate-wiki.ps1 Validator — must pass before push
page-index.json Machine-readable page index
llms.txt High-level map for LLM agents
agent-entrypoint.json Compact machine bootstrap

Full Agent Rule Set

See Agent-Guide for the complete HARD-rule table, trap taxonomy, claim protocol, and GUIDE-REV history. See the mission-repo AGENTS.md for SQF, PR, and source-editing rules.

Sidebar

Clone this wiki locally